api-performance-tests VS redoc

Since version v1.39.0 Starlite (released on the 12.11.22) no longer has any dependency on Starlette. Between this version and v1.45.0 that was released today (11.12.22), we have invested significant effort into benchmarking and optimizing code. One of our maintainers, @provinzkraut (Janek Nouvertné), has done amazing work rewriting our benchmarking framework. You can read more about this in here and run the benchmarks on your own by cloning the benchmark repository. The results are pretty impressive if I may say so myself:

Another important point I want to address is the framework's performance. The latest iteration of the TechPowered Benchmarks came out and they really surprised us. Starlite appeared rather slow there, and FastAPI was almost 200% faster thatn Starlette, which isn't technically possible given the structure of this library. Obviously something weird is happening there (no clue what), but this compelled us to invest some more efforts into our own benchmarking, the repository for which you can see here.

here: https://github.com/Goldziher/api-performance-tests

I used autocannon for this - which is a very cool benchmarking tool (I am not involved with it in any way). You can see the tests and more details in this repo. In a nutshell - I used identical setup for all 3 frameworks. Since both FastAPI and Starlite use Starlette as a basis, I also compared with Starlette.

I looked but still don’t understand… https://github.com/Goldziher/api-performance-tests/blob/main/results/json-starlite-sync-json-abc-1.json has 32k requests (per second?) but your graphs talk about 107

Legend: - a-: async, s-: sync - np: no params, pp: path param, qp: query param, mp: mixed params **Note*\*: only Starlite uses orjson by default - using their default settings both Starlette and FastAPI are significantly slower in serializing/deserializing JSON. You can find the tests in this repo, which also documents the test setup etc. As always, I invite you to checkout Starlite and maybe ⭐our repo. Starlite is a collaborative project - we have a discord server, which you can find here. You can find my previous reddit posts related to Starlite in these links: 1. Post regarding the builtin support for SQL Alchemy and the plugin system 2. Post introducing Starlite You can also read the article in medium (no pay gate) introducing Starlite.

You can find the tests in this repo, which also documents the test setup etc.

ReDoc Interactive Demo

ReDoc focuses on simplicity and readability, presenting the API documentation in a user-friendly format. It supports dark mode, multiple languages, and offers a seamless browsing experience for API consumers.

There are a few other tools out there that are at least marginally better than the default Swagger UI such as ReDoc (https://github.com/Redocly/redoc).

When we redid the Mux docs (https://docs.mux.com/api-reference) we actually just decided to build our own renderer. It really wasn't as bad as you might think, at build time we pull in the JSON version of our OAS spec and render it as a static build in our Nextjs app. Don't get me wrong, it wasn't trivial, but the benefit of having complete control over the output has been well worth it.

Redoc: http://localhost:8080/redoc

ReDoc is a tool that's similar to Swagger UI. It also takes an OAS and renders an interactive HTML page with full API documentation details; however, it has a notable difference.

take a look

Redoc is an open source tool to generate API reference documentation websites from OpenAPI definitions.

FastAPI for Python has an awesome way of doing this. It comes with two choices: Swagger and Redoc, the former being more interactive while the latter is (IMO) more visually appealing. I'm sure you could implement one of these using Spring.

Starlite has substantially enhanced OpenAPI (3.1) documentation - in fact, its the most complete autogenerated schema around, and it ships with Redoc, Swagger-UI and Stoplight-Elements static sites.