API documentation settings / DONE

On the ‘Site Settings’ page - in the ‘Configs’ section - in the ‘API DOCS’ block it is possible to specify the type of API methods that will be displayed in the API documentation.

circle-info

API documentation for the project is available at yourdomain.com/service/api-docs/#/. Example: develop.exchange/service/api-docs/#/arrow-up-right

  • To display public methods, select Yes for the SHOW PUBLIC METHODS field.

  • To display custom methods, select the ‘Yes’ option for the ‘SHOW USER METHODS’ field.

  • To display admin methods, select the ‘Yes’ option for the ‘SHOW ADMIN METHODS’ field.

  • To display server methods, select Yes for the SHOW SERVER METHODS field.

circle-info

The settings for this unit will be applied for 15 minutes after pressing the ‘Save’ button.

Last updated