HelloZeroNet / HelloZeroNet/ZeroNet
Implement JSON API to allow easier interfacing
- Dominant language
- JavaScript
- Stars
- 18.8k
- Forks
- 2.3k
- PR merge metrics
- No merged PRs in 30d
Description
### Environment
* ZeroNet version: from the future
* Operating system: All
### Describe the proposal:
Have an JSON API server to allow easier programmatic interaction with ZeroNet.
i.e. http://127.0.0.1:43110/api/sites?access_token=fcc0a328b7060b9394a0a73267c96bbb
#### Steps to reproduce:
1. Define the command set you would like to implement.
2. Write some **client side** code on a piece of paper before you start implementing anything. Since hand writing takes time, if it takes a lot of writing to use the interface, you should reconsider the API design.
3. Implement the interface, so that the example client code works.
4. Add a command line option for turning it on and off.
#### Benefits:
Developers need not simulate WebSocket requests anymore.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by defining the command set and writing the proposed client-side calls for the example JSON API endpoint. Then determine how the interface should be implemented and exposed through a command-line option; done means the example client interaction works and the API can be enabled or disabled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100