Swagger Documentation

The Eco game server provides an automated Swagger documentation JSON file for each version of the game. This file follows the Swagger v2.0 specification. It can be downloaded here.

Web Server Swagger UI

If you are an Eco DevTier user you can access the most recent up to date web documentation by using the Eco Webserver's built in documentation engine called Swagger.

When running your locally built development server access your ip + port with the path below, for example http://127.0.0.1:3001/swagger/ui/index#/. This URL is only accessible from the machine the server is currently running on.

/swagger/ui/index#/

Postman Collection

For API testing and development you can generate a Postman collection using the supplied Swagger v2.0 documentation. To do this download the documentation available here and import it into your Postman workspace.

For more information on importing the Eco Swagger specification see the "Importing and export data" documentation on Postman's website https://learning.postman.com/docs/getting-started/importing-and-exporting-data/.