The table shows the tools you can use when dealing with REST APIs. Some tools are referenced in this documentation, but you can use whichever tool you are comfortable with.
These tools aren't installed on the server. They're provided as tool recommendations for individual developers.
|curl||Command line tool and library for transferring data with URLs. It is used for REST interaction - for scripts and command line.|
|jq||Command line tool that processes JSON back and forth. Works well with curl.|
|Postman||Cross-platform tool to interact with REST resources. Easy to use and very powerful when testing APIs. We provide [sample collections] for it, for you to try.|
|CharlesProxy||HTTP(S) proxy to debug. Especially helpful when the client is not a browser.|
|Mockaroo||Online tool to generate sample data.|
|Let's Encrypt||Generates free SSL certificates.|
|SourceTree for GIT||Used for version control.|
|Swagger UI||Allows visualization and interaction with APIs without the need for actual implementation logic.|
We use Markdown to render this documentation in GitHub Pages using MKDoc Material with a few plugins.
Images used here are created in multiple ways:
- OmniGraffle (Mac)
- SmartDraw (Browser and Windows)
- PlantUML rendering text into images (using this VSCode plugin)
- Occasionally Balsamiq for Wireframes
- GIMP to postprocess screenshots if needed
- ... and a few others