RESTEndpointRenderSection

A section that contains a REST API endpoint.

struct RESTEndpointRenderSection

Discussion

This section is similar to DeclarationRenderSection for symbols and describes a tokenized endpoint for a REST API. The token list starts with an HTTP method token followed by tokens for the complete endpoint URL. Any path components that are dynamic instead of fixed are represented with a parameter name enclosed in curly brackets.

A complete token representation for the endpoint GET https://www.example.com/api/artists/{id} is (the token kind is in brackets):

(method) GET
(baseURL) https://www.example.com
(path) /api/artists/
(parameter) {id}

Topics