API method

API method content block

An API Method block is used to manually document an HTTP API endpoint.

Example of API Method block

Get a user

GET https://api.example.com/v1/user

Use this method to get information about a user

You can now convert the API blocks to full width by clicking on the next to the block. Read more about full-width blocks.

Please also check:

OpenAPI