Skip to main content

Routes

A route redirects the incoming request to an action. You can attach various meta information to a route like the request and response schema or a description. Fusio can use this information to generate a fitting OpenAPI specification or client SDK. If a request method is public it is possible to request the API endpoint without an access token.

routes_update

Path​

The path can contain variable path fragments. These fragments can be accessed inside an action. The following list describes the syntax.

  • /product No variable path fragment only the request to /product matches this route

  • /product/:product_id Simple variable path fragment. This route matches to any value except a slash. I.e. /product/foo or /product/12 matches this route

  • /product/$year<[0-9]+> Variable path fragment with a regular expression. I.e. only /product/2015 matches this route

  • /file/*path Variable path fragment which matches all values. I.e. /file/foo/bar or /file/12 matches this route

Scopes​

The scopes field defines a set of scopes assigned to a route. If the route is protected, an end user needs to obtain a scope in order to access the endpoint.

Status​

The status affects the behaviour of the API endpoint. The following list describes each status

  • Development Used to develop a new API endpoint. It adds a "Warning" header to each response that the API is in development mode.

  • Production Used if the API is ready for production use.

  • Deprecated Used if you want to deprecate a specific version of the API. Adds a "Warning" header to each response that the API is deprecated.

  • Closed Used if you dont want to support a specific version anymore. Returns an error message with a 410 Gone status code

Action​

The action contains the business logic of your API endpoint. It selects or inserts entries from a database or pushes a new entry to a message queue. Through the dropdown you can simply select an action.

Costs​

Contains how much a user needs to pay in order to invoke a route. A user can obtain points by buying a specific plan at the developer portal.