APTX is a URL shortener. It names derived from APTX 4869 which shrunk Sinichi Kudo to Conan Edogawa.
The API can be seen in proto files (*.proto
) in directory proto/
.
The API is automatically generated in OpenAPIv2 format when generating gRPC codes.
The generated files are stored in directory openapiv2
in JSON format (*.json
).
To see the RESTful API contract, do the following:
- Open the generated json file(s)
- Copy the content
- Open https://editor.swagger.io/
- Paste the content in https://editor.swagger.io/
- Read Prerequisites
- Then, read How to Run
- Read Prerequisites
- Then, read Development Guide
- Read Code Map
- Read FAQs