hub.eb?material_id=529&track_id=532

Documenting a REST Endpoint


Verj.io Studio integrates with Swagger to provide structure for your REST Web Service Documentation.

For each endpoint in your Web Service, Verj.io gives you the ability to populate information about the HTTP Request and HTTP Response including required Headers, Parameters and Authentication.

The image below demonstrates editing the top-level REST Web Service information.

The image below demonstrates editing the Endpoint Information

The image below demonstrates editing the Request Parameter Information.

The documentation will then be outputted to a standard format as below.

 

Current Module

Related