swagger-petstore VS orchid-orm-benchmarks

Now, we can start our server and visit the Swagger UI at http://localhost:port/documentation. The documentation will be empty for now, but we will add our endpoints later on. You can also have a look at how the Swagger UI looks in the Swagger's online demo.

I think there's also a missing gap in how to present Swagger beautifully, the default one ( https://petstore.swagger.io/ ) is meh. I'm looking for something that can generate like https://stripe.com/docs/api but open source (since the OP is talking about it).

I imagine a tool(chain) that can take Swagger generated from annotations in code, and combine it with a folder containing Markdown files for "free form" documentation, and generate a Hugo/Jekyll static site that can be deployed in Cloudflare Pages in docs.mycompany.com

You can go to https://petstore.swagger.io/

Controllers handle the incoming requests, and their responses. Generally you design a "contract" that describes how to properly format a request to your application, and which response you may expect. Swagger is the tool to write the contract, and REST are the principles that guide you. Take a look at the swagger petstore for an example. Ask for a swagger file of your application, and the corresponding Controller, and you should be able to see the connection.

Your question is a bit unclear. Are you trying to find an example OpenAPI document for some REST web services? If yes, check the Pet Store project: https://petstore.swagger.io/

So you mean there is an endpoint on each of your service that will bring you to a view like the PetStore example?

I am a backend dev myself. I use pet store api collection as a reference for REST APIs best practices https://petstore.swagger.io

Automation for many routines starts with interaction via API. This case can be treated in many ways, but I want to take a look at interacting with web API using a generated Kotlin client. I found a lot of academic examples for generating Kotlin clients (most of them are based on the PetStore), but nothing was close to real-world examples. My goal is to build a Kotlin client for a complex API and see how it works. Here is the source code of the Kotlin project that I will use in the post.

Here are my tests for an example project. The logic is quite straightforward: create db records, make a request, check the response, and if it was a mutating request check how it affected the database.

And if you like to see a random example project here is mine, but my point is that a random project won't really help because each project has a unique set of frameworks/libs/practices and it changes almost everything.

Or you can clone this examples repo and play with the Blog API code.

I have an example app, and have written documentation based on it, and I'd appreciate it if you could look and give some feedback. Yes, the doc is about ORM, but imagine the ORM is just an implementation detail and instead look at how validations, controllers, repos, and especially tests are done. Source code, and long boring tutorial about it. Really, check the tests here, they are special. It doesn't have "service" because the app is too simple, but I usually have a service layer as a files with exported functions. Error handling is in app.ts.

I keep all routes in a separate file: routes.ts, in case of multiple API versions it could be "routes.v1.ts", "routes.v2.ts" and so on. v1 and v2 can reuse the same controllers.

I wrote some tests for sample app as well, maybe could be interesting for you to check it out: here, criticism is welcome, just as I like to criticize