http-api-docs

A generator for Kubo (go-ipfs) RPC /api/v0 endpoints documentation.

Note: This is just the generator for the docs that are available on https://docs.ipfs.tech/reference/kubo/rpc/

The original docs are written in Markdown format and are available for community contributions here: https://github.com/ipfs/ipfs-docs

Table of Contents

• http-api-docs
• Table of Contents
  • Install
  • Usage
  • Captain
  • Contribute
  • License

Install

In order to build this project, you need to first install Go, clone this repo, and finally run make install:

> git clone https://github.com/ipfs/http-api-docs "$(go env GOPATH)/src/github.com/ipfs/http-api-docs"
> cd "$(go env GOPATH)/src/github.com/ipfs/http-api-docs"
> make install

Usage

After installing you can run:

> http-api-docs

This should spit out a Markdown document. This is exactly the rpc.md documentation at https://github.com/ipfs/ipfs-docs/blob/master/docs/reference/kubo/rpc.md, so you can redirect the output to just overwrite that file.

Captain

This project is captained by @hsanjuan.

Contribute

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT (C) Protocol Labs, Inc.