https://github.com/lepetitbloc/bitcoin-swagger

Bitcoind Rest API Swagger specification document (OpenAPI)
https://github.com/lepetitbloc/bitcoin-swagger

bitcoin openapi swagger

Last synced: about 1 month ago
JSON representation

Bitcoind Rest API Swagger specification document (OpenAPI)

• Host: GitHub
• URL: https://github.com/lepetitbloc/bitcoin-swagger
• Owner: LePetitBloc
• License: mit
• Created: 2018-04-09T11:50:59.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-24T12:58:20.000Z (over 6 years ago)
• Last Synced: 2024-10-15T04:33:00.142Z (3 months ago)
• Topics: bitcoin, openapi, swagger
• Language: HTML
• Homepage: https://lepetitbloc.github.io/bitcoin-swagger/
• Size: 8.57 MB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bitcoin OpenAPI specification (swagger)

**Bitcoin** Rest API swagger specification document in Yml and Json (OpenAPI).

> The current version uses the Version 2.0 of the OpenAPI Specification:

> https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

## Usage

You can import the YML/Json file in the [Swagger editor](http://editor.swagger.io/) and generate a client for any [supported languages](https://swagger.io/open-source-integrations/).

## Clients

A collection of pre-generated client repositories is available in the **bitcoind-rest** group:

https://github.com/bitcoind-rest

## Resources

* Docs https://lepetitbloc.github.io/bitcoin-swagger/

* Version 2.0 of the OpenAPI Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

* https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md

## Common pitfalls

Bitcoin Rest API doesn't provide any mechanism to handle CORS. For the time being we recommend to setup an Nginx proxy in front of the **Bitcoin** Rest API.

> see the following PR on Bitcoin repository:

> [add support for CORS headers](https://github.com/bitcoin/bitcoin/pull/12040)

## Development

> We're using a local [swagger-editor](https://github.com/swagger-api/swagger-editor) and a `bitcoind` binary running on the `testnet` to develop and live-test the specification file.

> You can start them both as containers with docker-composer.

1. Start `bitcoind` and `swagger-editor` containers via `docker-compose`:

```

docker-compose up

```

2. Visit http://localhost:3000

3. Import `swagger.yml` from the *> File > Import file* menu in the GUI.

> **Note:** The YML file is used as the reference, the Json file is exported via the GUI.

## Licence

MIT