modulepackage
0.0.0-20191228003101-3528c8a996e4
Repository: https://github.com/tron-us/http-api-docs.git
Documentation: pkg.go.dev
# README
http-api-docs
A generator for go-btfs API endpoints documentation.
Table of Contents
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/TRON-US/http-api-docs "$(go env GOPATH)/src/github.com/TRON-US/http-api-docs"
> cd "$(go env GOPATH)/src/github.com/TRON-US/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 api.md documentation at https://github.com/TRON-US/go-btfs/tree/master/docs/content/reference/api/http.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) TRON-US
# Packages
This is an utility to generate documentation from go-btfs commands.
# Functions
AllEndpoints gathers all the endpoints from go-btfs.
No description provided by the author
Endpoints receives a name and a go-btfs command and returns the endpoints it defines] (sorted).
GenerateDocs uses a formatter to generate documentation for every endpoint.
# Constants
No description provided by the author
How much to indent when generating the response schemas.
Failsafe when traversing objects containing objects of the same type.
# Variables
A map of single endpoints to be skipped (subcommands are processed though).
No description provided by the author
# Structs
Argument defines an BTFS RPC API endpoint argument.
Endpoint defines an BTFS RPC API endpoint.
MarkdownFormatter implements a markdown doc generator.
# Interfaces
Formatter allows to implement generation of docs in different formats.