Swagger

Swagger is a set of open-source tools built around the OpenAPI Specification that can help you design, build, document and consume REST APIs.

The major Swagger tools include:

  • Swagger Editor – browser-based editor where you can write OpenAPI specs.
  • Swagger UI – renders OpenAPI specs as interactive API documentation.
  • Swagger Codegen – generates server stubs and client libraries from an OpenAPI spec.

restdb.io can generate a complete Swagger description file for your database API.

In development mode, navigate to the API tools section.

This section contains:

  • Link to Swagger file URL
  • Generated Swagger documentation for your database REST API
  • Link to open the Swagger file URL in the Swagger editor

Swagger API documentation

The screen shot below show how this looks for our sample database.

swagger

To generate a complete API documentation for the database, click the Open link. This opens a new window with your API documentation.

The screen shot below shows an example.

swagger-ui Live preview link here.

Swagger editor

Furthermore, if you click the Open link to the Swagger editor, you can view/edit the API specification. You can also generate API clients for a wide range of programming languages; Swift, Kotlin, Go, Android, CSharp, PHP, Java, Javascript, Typescript - just to mention a few.

The screen show below shows the Swagger editor for our sample database API.

swagger-editor