Skip to main content
Version: v1

Introduction

You can access autogenerated Swagger API specifications at <domain name>/api-docs url.
For example, 

http://localhost:3000/api-docs

Godspeed also provides a facility to auto-generate OAS 3 documentation using CLI.

5.1 CLI command to generate documentation​

You can generate OAS3 documentation using godspeed gen-api-docs CLI command.

5.2 Custom Server URL​

You can add custom server URL for API documentation in static configuration By adding the custom server url, your autogenerated documentation or swagger specs will have this url set in the Servers.

server_url: https://api.example.com:8443/v1/api

For example, Swagger specs