https://github.com/wfcd/api-spec

OpenAPI Specifications for WarframeStat.us API
https://github.com/wfcd/api-spec

documentation openapi openapi-specification openapi3 swagger

Last synced: 3 months ago
JSON representation

OpenAPI Specifications for WarframeStat.us API

• Host: GitHub
• URL: https://github.com/wfcd/api-spec
• Owner: WFCD
• License: mit
• Created: 2017-12-21T18:21:32.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-16T01:28:07.000Z (3 months ago)
• Last Synced: 2024-10-17T14:08:42.458Z (3 months ago)
• Topics: documentation, openapi, openapi-specification, openapi3, swagger
• Language: CSS
• Homepage: https://docs.warframestat.us
• Size: 1.9 MB
• Stars: 1
• Watchers: 9
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# WarframeStat.us OpenAPI Specification

[![GitHub pages](https://github.com/WFCD/api-spec/actions/workflows/docs.yaml/badge.svg)](https://github.com/WFCD/api-spec/actions/workflows/docs.yaml)

## Links

- [Reference Documentation (ReDoc)](https://docs.warframestat.us)

- [SwaggerUI](https://docs.warframestat.us/swagger-ui/)

- OpenAPI Raw Files: [JSON](https://docs.warframestat.us/openapi.json) [YAML](https://docs.warframestat.us/openapi.yaml)

**Warning:** All above links are updated only after Actions finishes deployment

## Working on specification

### Install

1. Install [Node JS](https://nodejs.org/)

2. Clone repo and run `npm install` in the repo root

### Usage

#### `npm start`

Starts the development server on port [`8080`](http://localhost:8080).

#### `npm run bundle`

Bundles the spec and prepares web_deploy folder with static assets.

#### `npm test`

Validates the spec.

#### `npm run gh-pages`

Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured.