swagger-petstore VS prism

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.

Since the OpenAPI can effectively describe our resources, we can reuse it to generate a dummy server that can be later used for development and testing purposes without bootstrapping any actual services. There some tools available that can help us with this task, such as Prism, OpenAPI Mock, OpenAPI Backend and the MSW library we have already seen.

I use https://stoplight.io/open-source/prism with x-faker properties in my OpenAPI specs to mock APIs with dynamic content.

Haven't tried it yet, but discovered https://microcks.io/ yesterday. Otherwise https://stoplight.io/open-source/prism is pretty good

Prism does more than mocking; You can also use it to inspect any discrepancies between your API implementation and the API spec. You can find out more on their GitHub page:https://github.com/stoplightio/prism

use a mock API server that can read openapi spec (e.g. Prism)

prism

What about skipping the DB all together and using OpenAPI w/ a Mock Server for local development https://openapi.tools/#mock personally like https://stoplight.io/open-source/prism

Pretty simple to run [prism](https://github.com/stoplightio/prism) locally for free.