We wrote the documentation for Web5 in Insomnia HTTP client which is free and open source client available for Windows, Linux and macOS. API Documentation in Insomnia client will bring you flexible and interactive experience while you are working on your own application with the Web5 API.
- Download and install Insomnia HTTP client.
- Open Insomnia client and create new project via Git Clone button.
- Paste url address
https://github.com/linkspreed/Web5_APIinto URL input and confirm the popup. - Open newly created document and switch at center of the top navigation into Debug tab.
- That's all.
To properly run all documented endpoints you have to set environment variables.
In the top left corner you will see Config dropdown menu, click on it and select Manage Environments. In Config environment you will see two variables which you have to edit on your own.
base_url- The base url of your running server with Web5token- The authentication token generated in the Web5 app or obtained via/api/loginlogin route.
We are providing you 1 backend which you can set and play via Insomnia HTTP clients:
https://web5.cf
Interface is divided into three parts:
All Web5 API endpoints sorted into multiple categories
Contains URL address bar with 5 Tabs:
- Body of the request
- Request authorization with bearer token for all secured endpoints
- Queries for your request
- Header setup for sending requests
- Docs where you find explanations for current endpoint
The original response of the request which was sent