https://github.com/symbol/symbol-openapi
OpenAPI specification for catapult-rest
https://github.com/symbol/symbol-openapi
api docs documentation nem open-api open-api-specification rest specification swagger symbol
Last synced: about 1 year ago
JSON representation
OpenAPI specification for catapult-rest
- Host: GitHub
- URL: https://github.com/symbol/symbol-openapi
- Owner: symbol
- License: apache-2.0
- Created: 2019-08-07T09:29:21.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-02-20T17:55:40.000Z (about 1 year ago)
- Last Synced: 2025-03-25T18:39:49.068Z (about 1 year ago)
- Topics: api, docs, documentation, nem, open-api, open-api-specification, rest, specification, swagger, symbol
- Language: Shell
- Homepage: https://nemtech.github.io/api.html
- Size: 2.47 MB
- Stars: 13
- Watchers: 22
- Forks: 6
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# symbol-openapi
[](https://travis-ci.com/nemtech/symbol-openapi)
OpenAPI specification for catapult-rest.
## Requirements
* Node.js 12 LTS
## Installation
1. Clone the ``symbol-openapi`` repository.
```
git clone https://github.com/nemtech/symbol-openapi.git
```
2. Install ``swagger-cli`` globally.
```
npm install -g @apidevtools/swagger-cli
```
## Commands
### Build
Compile the specification.
The generated output is saved under ``_build`` directory.
```
npm run build
```
### Test
Check if the specification is valid.
```
npm run test
```
## Contributing
Before contributing please [read this](CONTRIBUTING.md).
## License
Copyright (c) 2018-present NEM
Licensed under the [Apache License 2.0](https://github.com/nemtech/nem2-docs/blob/master/LICENSE)