httpapi

README

go-ipfs-http-api

⚠️ This package is no longer being maintained here. ⚠️

It has been moved into kubo's repo at github.com/ipfs/kubo/client/rpc.

This allows that any updates or change to kubo's coreapi is immediately reflected on the client too.

License

MIT

Documentation

Overview

Deprecated: This repo has moved inside Kubo in order to make it easier to keep kubo and the http-client in sync, please use github.com/ipfs/kubo/client/rpc instead.

Index

• Constants
• Variables
• func ApiAddr(ipfspath string) (ma.Multiaddr, error)
• type BlockAPI
• type DhtAPI
• type Error
• type HttpApi
  • func NewApi(a ma.Multiaddr) (*HttpApi, error)
  • func NewApiWithClient(a ma.Multiaddr, c *http.Client) (*HttpApi, error)
  • func NewLocalApi() (*HttpApi, error)
  • func NewPathApi(ipfspath string) (*HttpApi, error)
  • func NewURLApiWithClient(url string, c *http.Client) (*HttpApi, error)
• type HttpDagServ
• type KeyAPI
• type NameAPI
• type ObjectAPI
• type PinAPI
• type PubsubAPI
• type Request
  • func NewRequest(ctx context.Context, url, command string, args ...string) *Request
• type RequestBuilder
• type Response
• type RoutingAPI
• type SwarmAPI
• type UnixfsAPI

Constants

const DefaultApiFile = rpc.DefaultApiFile

Deprecated: use rpc.DefaultApiFile instead.

const DefaultPathName = rpc.DefaultPathName

Deprecated: use rpc.DefaultPathName instead.

const DefaultPathRoot = rpc.DefaultPathRoot

Deprecated: use rpc.DefaultPathRoot instead.

const EnvDir = rpc.EnvDir

Deprecated: use rpc.EnvDir instead.

Variables

var ErrApiNotFound = rpc.ErrApiNotFound

Deprecated: use rpc.ErrApiNotFound instead.

Functions

func ApiAddr

func ApiAddr(ipfspath string) (ma.Multiaddr, error)

Deprecated: use rpc.ApiAddr instead.

Types

type BlockAPI

type BlockAPI = rpc.BlockAPI

Deprecated: use rpc.BlockAPI instead.

type DhtAPI

type DhtAPI = rpc.DhtAPI

Deprecated: use rpc.DhtAPI instead.

type Error

type Error = rpc.Error

Deprecated: use rpc.Error instead.

type HttpApi

type HttpApi = rpc.HttpApi

Deprecated: use rpc.HttpApi instead.

func NewApi

func NewApi(a ma.Multiaddr) (*HttpApi, error)

Deprecated: use rpc.NewApi instead.

func NewApiWithClient

func NewApiWithClient(a ma.Multiaddr, c *http.Client) (*HttpApi, error)

Deprecated: use rpc.NewApiWithClient instead.

func NewLocalApi

func NewLocalApi() (*HttpApi, error)

Deprecated: use rpc.NewLocalApi instead.

func NewPathApi

func NewPathApi(ipfspath string) (*HttpApi, error)

Deprecated: use rpc.NewPathApi instead.

func NewURLApiWithClient

func NewURLApiWithClient(url string, c *http.Client) (*HttpApi, error)

Deprecated: use rpc.NewURLApiWithClient instead.

type HttpDagServ

type HttpDagServ = rpc.HttpDagServ

Deprecated: use rpc.HttpDagServ instead.

type KeyAPI

type KeyAPI = rpc.KeyAPI

Deprecated: use rpc.KeyAPI instead.

type NameAPI

type NameAPI = rpc.NameAPI

Deprecated: use rpc.NameAPI instead.

type ObjectAPI

type ObjectAPI = rpc.ObjectAPI

Deprecated: use rpc.ObjectAPI instead.

type PinAPI

type PinAPI = rpc.PinAPI

Deprecated: use rpc.PinAPI instead.

type PubsubAPI

type PubsubAPI = rpc.PubsubAPI

Deprecated: use rpc.PubsubAPI instead.

type Request

type Request = rpc.Request

Deprecated: use rpc.Request instead.

func NewRequest

func NewRequest(ctx context.Context, url, command string, args ...string) *Request

Deprecated: use rpc.NewRequest instead.

type RequestBuilder

type RequestBuilder = rpc.RequestBuilder

Deprecated: use rpc.RequestBuilder instead.

type Response

type Response = rpc.Response

Deprecated: use rpc.Response instead.

type RoutingAPI

type RoutingAPI = rpc.RoutingAPI

Deprecated: use rpc.RoutingAPI instead.

type SwarmAPI

type SwarmAPI = rpc.SwarmAPI

Deprecated: use rpc.SwarmAPI instead.

type UnixfsAPI

type UnixfsAPI = rpc.UnixfsAPI

Deprecated: use rpc.UnixfsAPI instead.