https://github.com/lepetitbloc/ipfs-swagger
[WIP] IPFS Rest API Swagger specification document (OpenAPI)
https://github.com/lepetitbloc/ipfs-swagger
ipfs openapi openapi-specification swagger
Last synced: 2 months ago
JSON representation
[WIP] IPFS Rest API Swagger specification document (OpenAPI)
- Host: GitHub
- URL: https://github.com/lepetitbloc/ipfs-swagger
- Owner: LePetitBloc
- License: mit
- Created: 2018-05-03T14:14:31.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-30T13:21:13.000Z (almost 8 years ago)
- Last Synced: 2025-06-03T19:18:55.951Z (about 1 year ago)
- Topics: ipfs, openapi, openapi-specification, swagger
- Homepage: https://lepetitbloc.github.io/ipfs-swagger/
- Size: 21.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# IPFS OpenAPI specification (swagger)
**IPFS** 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
## Why?
Swagger (v2) and OpenAPI (v3) are specification for describing an API. Writing a swagger file is useful when you want to generate a documentation, make quick tests from a browser or generate multiple API clients.
## Usage
You can import the yaml/json file in the [Swagger editor](http://editor.swagger.io/) and generate a client for any [supported languages](https://swagger.io/open-source-integrations/).
## License
IPFS OpenAPI is under the [MIT License](LICENSE.md).
## Donation
We love cryptocurrencies, consider making a donation:
| Currency | Address |
| ---------------- | ------------------------------------------ |
| Bitcoin | 14VRBrDZ47HR1pWjmAnyC5CJCXDkhLeANb |
| Ethereum | 0x1accf4c2bd6010100a2aeac36f336fb963a1716a |
| Ethereum Classic | 0x3b33bdcc70f06dad7068594a0cd8fbfd7b203aae |
| Litecoin | LdH6Sbq5M9p6dqG7GaRvBjoCqJ2CHnz9wr |
| Dash | XuPyN4Ns12qaMKzUjffzeKrCjCL4XYwUCY |
| ZCash | t1U2e4TV6zmg6gXAByBp59NtBP2HsEvY5T5 |
| Doge | DKbojeYrguCL2Suh9ujmU49m4QK9DixBXL |
## Code of conduct
See the [CODE OF CONDUCT](CODE_OF_CONDUCT.md) file.
## Contributing
See the [CONTRIBUTING](CONTRIBUTING.md) file.
## Support
See the [SUPPORT](SUPPORT.md) file.
## Credits
- README, CONTRIBUTING and LICENSE are heavily inspired by [project-template](https://github.com/mnapoli/project-template)
- Issue and Pull Request templates comes from [Open-Source Templates](https://www.talater.com/open-source-templates/#/)
- CODE_OF_CONDUCT come from [Contributor Covenant](https://www.contributor-covenant.org)