https://github.com/easbar/directions-api-doc

Official Documentation for the GraphHopper Directions API
https://github.com/easbar/directions-api-doc

Last synced: 2 months ago
JSON representation

Official Documentation for the GraphHopper Directions API

• Host: GitHub
• URL: https://github.com/easbar/directions-api-doc
• Owner: easbar
• License: apache-2.0
• Created: 2019-08-08T09:44:31.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-05T07:45:52.000Z (almost 5 years ago)
• Last Synced: 2025-01-24T11:44:32.474Z (4 months ago)
• Language: HTML
• Homepage: https://docs.graphhopper.com
• Size: 4.58 MB
• Stars: 0
• Watchers: 1
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GraphHopper Directions API OpenAPI Specification

[![Build Status](https://travis-ci.com/graphhopper/directions-api-doc.svg?branch=master)](https://travis-ci.com/graphhopper/directions-api-doc)

## Links

- [View Documentation (ReDoc)](https://graphhopper.github.io/directions-api-doc/)

- OpenAPI Raw Files: [JSON](https://graphhopper.github.io/directions-api-doc/openapi.json) [YAML](https://graphhopper.github.io/directions-api-doc/openapi.yaml)

**Warning:** All above links are updated only after Travis CI 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.

#### `npm run build`

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.