swagger-editor VS gin-swagger

To test it out, you can copy the generated build file and paste it in Swagger live editor.

One of the powerful features of OpenAPI is the ability to generate code automatically. Using tools like Swagger, you can generate both client and server code using options "Generate Server" or "Generate Client" available on https://editor.swagger.io/

Install Swagger tools like Swagger Editor, Swagger UI, and Swagger Codegen.

Having docs as the JSON file is the most important, but can we also present it somehow? Sure we can. Enter Swagger UI! And I am not talking about the Swagger Editor, but our very own instance!

I did the same for the other API and adjusted the spec using the Swagger Editor. Specifically, I added detailed descriptions that should help the agent understand the API usages. The resulting OpenAPI YAML file is as follows:

It has an online editor. You can easily play around with it and generate easy-to-use documentation.

After running the collection, I can see the API spec that was created and the mock server endpoint to test it. Looking at the rendered version on Swagger's OAS editor we can see pretty clearly this is a complete API that gets us exactly what we need.

While there’s not an officially supported Java SDK for Marqeta, building a Java client is quite straightforward, as the Core API is documented in both Swagger v2.0 and OpenAPI v3.0. The OpenAPI documentation is in beta, but it is generated directly from the API source code. To get a Java client, all we need to do is drop the OpenAPI yaml file into editor.swagger.io, modify the servers section to use the https://sandbox-api.marqeta.com/v3 as the URL, and tell it to generate a Java client.

Check out https://editor.swagger.io/ as a start point. In theory you should be able to generate a client for any swagger complient api and plug in your own auth and custom logic.

I would suggest using the swagger editor: https://editor.swagger.io/

No I use this one https://github.com/swaggo/gin-swagger. It's with swagger 2.0, but I think it can be easily converted to OpenApi 3.0. I tried it once and the only thing it complained about was some simple "metadata" like contact person etc.

I don't use Gin, but I took the canonical example from https://github.com/swaggo/gin-swagger#canonical-example, removed the url := ginSwagger.URL line entirely (and removed url from the next line), and it works as expected locally or when deployed in kubernetes (via kind) for me.