gagaception / echo Goto Github PK

The application allows creating new routes dynamically to which developers can assign:

• verb
• path
• response

bundle install
rake db:setup db:migrate
rails server

In order to expose this API to the proper consumers it is relevant to expose clear documentation of the available endpoints while maintaining that documentation always current in time.

The best way to document a REST API is to expose a Swagger file and define on that file all their requirements that each endpoint needs for its proper operation.

Swagger UI api-docs

To test endpoints send request to the server with correct verb and path:

Server MUST respond with not_found error if verb is different from Endpoints record: