ipfs/kubo

HTTP API root

Open

#807 opened on Feb 24, 2015

View on GitHub
 (15 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wantedneed/analysistopic/apitopic/rpc-api

Description

HTTP API root (e.g. http://localhost:5001/) should show a listing with links to:

  • /webui
  • show locally installed, trusted apps. (right now only webui)
  • list the URL to the api: /api/v0/<command>?arg=<args>&<flags>

thanks @dominictarr

Contributor guide

Tech stack
gorest api
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Go knowledgeUnderstanding of HTTP APIs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the existing HTTP API routes in the Go codebase, likely in core/http or similar. Check linked PRs or comments for any prior attempts. Implement a new handler at the root path that returns a JSON listing of endpoints referencing /webui and /api/v0.