User Tools
Below is the list of tools that can be used when dealing with REST APIs. Some of these tools are referred to in this documentation. You can, however, use whichever tool you are comfortable with.
| Tool Name | Description |
|---|---|
| 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. |
Developer Tools
Below are the requirements for contributing to or extending KEEP:
- An editor or IDE of your choice:
- Eclipse or Eclipse Che
- VSCode with Java plugins
- IntelliJ
- A solid understanding of Maven
- The vert.x framework for Java, JavaScript and others
- Apicurio, which is an online GUI editor for OpenAPI files
Check the details to setup the development environment
Documentation
We use Markdown to render this documentation in GitHub Pages using the custom Just-The-Docs theme.
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