orval VS swagger-ui

In cases where the client needs to stay separate, we have had a good experience with Orval[1] to generate a fully-typed @tanstack/query client from our OpenAPI spec.

[1] https://orval.dev/

- Vite/React/Tailwind for the frontend, with [Orval](https://orval.dev/) to generate FE definitions based on the API spec.

For non-API/SPA use-cases, it also has good HTML support, with built-in Jinja and HTMX integrations. The docs are great (https://docs.litestar.dev/latest/ - not quite Django-tier but that's the gold standard), however the reference application is a tad too complex imo (https://github.com/litestar-org/litestar-fullstack).

https://github.com/litestar-org/awesome-litestar has a list of useful extensions - highly recommend trying it out if you are starting a new Python web project.

In order to generate the API client, there are a few options available, but we are going to use (Orval)[https://orval.dev]. Orval is a CLI tool that generates API clients based on an OpenAPI specification. It supports TypeScript, JavaScript, Axios, React, Vue, Angular and Svelte and it's highly customizable.

I would use "reveal": "never" if I don't care about the results of the command, for example, I generate swagger types using orval.dev on every folder open, but I want this to run in background as it's not that important, so I use "reveal": "never" for it.

we started using (and now contributing to) https://orval.dev/ this year which both generates the mocks using MSW as well as the client-side networking code (React Query in our case). It removes so much boilerplate its amazing.

wrote up the basics of our workflow few weeks ago https://betaacid.co/blog/api-contracts

Personally, find gRPC-Web very attractive but the current state of TypeScript/JS code-gen is very confusing and lacking.

I would love something like https://orval.dev for gRPC-web. Have I missed something or is it just early to expect it?

I tried a few libraries but couldn't get them to work or would generate unappealing results. I believe I'm hitting this issue with my local experiments. https://github.com/grpc/grpc-web/issues/535

This is a Library I've used in the past, https://github.com/anymaniax/orval

If you have OpenAPI specs to work with you could also use Orval (https://orval.dev/) to generate a lot of code. We’re just starting to evaluate it at work but so far the team that’s trialing it is liking it.

On the frontend we can use the OpenAPI docs to generate the TS types for our data structures. Not only types but fetch functions as well as react-query hook can be generated as well. And in this blog post you can see how to do that with a library called Orval.

On this page, we’ll use a code generator called Orval.

Swagger is a fantastic open-source toolset that's perfect for developing and describing RESTful APIs. It offers you a user-friendly interface to understand a service's capabilities without needing to dig into the code. It even provides a way for you to interact directly with the API, which means you get to test its functionality.

The API had an OpenAPI endpoint built with Swagger where I could download a JSON specification file for the API.

Swagger is a widely used tool for documenting and testing APIs.

Swagger is an open-source software framework that implements the OpenAPI Specification—an API description format for REST APIs. The OpenAPI Specification defines a standard, language-agnostic interface to HTTP APIs, enabling both humans and computers to discover and understand the capabilities of the API.

Mocking and Testing: Once the API design is complete, developers create mock APIs to simulate the behavior of the actual services. This early testing phase helps identify any issues or mismatches between design and implementation before substantial development efforts are invested. Tools like Postman or Swagger are invaluable for API testing and validation.

import fp from "fastify-plugin"; import swagger from "@fastify/swagger"; export default fp(async (fastify) => { fastify.register(swagger, { openapi: { info: { tags: [ { name: "drinks", description: "Drink-related endpoints", externalDocs: { description: "Find out more", url: "http://swagger.io", }, }, ], }, }, }); });

A very requested feature for Sharkio was the auto-generation of OpenAPI documentation using the recorded HTTP requests - to create standardized documentation.

Automation QA is a lot of the same duties as manual QA, but instead of writing and executing the test plans manually, we create and update automated tests that can run those validations programmatically, for example by using Selenium to automatically fill out and submit forms for a web application, or using Postman and/or Swagger to generate an API conversation test.