$customHeader
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

All APIs shall be documented in Postman compatible JSON file.

The bucket to keep the API documentation is available here:

https://bitbucket.org/ctiteam/apis-documentation/src

You need to follow the rules mentioned below in your API development project:

  • every API has to be tested in the Pipeline

  • every new API endpoint has to be added to the documentation file before running the pipeline

  • for any change or adding documentation files in the repository you will have to send pull request

  • the collection file has to follow the exact project’s repository name

 

To learn how to use postman to build the API documentation visit:

http://kb.sites.apiit.edu.my/knowledge-base/ci-cd-api-testing-using-postman/

  • No labels