Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/symbol/symbol-openapi

api docs documentation nem open-api open-api-specification rest specification swagger symbol

Last synced: about 17 hours 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 (about 5 years ago)
Default Branch: main
Last Pushed: 2022-05-12T16:09:35.000Z (over 2 years ago)
Last Synced: 2024-09-20T17:12:32.381Z (5 days 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: 3.69 MB
Stars: 12
Watchers: 21
Forks: 6
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

# symbol-openapi

[![Build Status](https://travis-ci.com/nemtech/symbol-openapi.svg?branch=main)](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)