https://github.com/opengeospatial/ogcapi-routes
public repo for OGC API - Routes Standards Working Group
https://github.com/opengeospatial/ogcapi-routes
Last synced: 3 months ago
JSON representation
public repo for OGC API - Routes Standards Working Group
- Host: GitHub
- URL: https://github.com/opengeospatial/ogcapi-routes
- Owner: opengeospatial
- License: other
- Created: 2021-01-13T13:42:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2026-02-24T16:42:35.000Z (4 months ago)
- Last Synced: 2026-02-24T20:56:46.907Z (4 months ago)
- Language: CSS
- Size: 1.73 MB
- Stars: 12
- Watchers: 12
- Forks: 4
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Routing SWG
This GitHub repository contains [OGC](http://opengeospatial.org)'s proposed standards for routing.
The editor's drafts of the specifications can be found at
* [OGC API - Routes - Part 1: Core](https://docs.ogc.org/DRAFTS/21-000.html)
* [OGC Route Exchange Model](https://docs.ogc.org/DRAFTS/21-001.html)
[OGC API standards](https://ogcapi.ogc.org) define modular API building blocks to spatially enable Web APIs in a consistent way. [OpenAPI](http://openapis.org) is used to define the reusable API building blocks with responses in JSON and HTML.
The OGC API family of standards is organized by resource type. OGC API Routes specifies API building blocks for interacting with routes.
The work on the API started in the [OGC Open Routing Pilot](https://www.ogc.org/projects/initiatives/routingpilot).
## Overview
In addition to the resources provided through inheritance from [OGC API - Common](https://ogcapi.ogc.org/common), the following resources are also provided by [OGC API - Routes](https://ogcapi.ogc.org/routes):
```
POST /routes
```
Compute a new route.
```
GET /routes
```
Fetch routes.
```
GET /routes/{routeId}
```
Fetch a route.
```
DELETE /routes/{routeId}
```
Delete a route.
```
GET /routes/{routeId}/definition
```
Fetch the definition of a route.
## Communication
Most of the work on the specification takes place in [GitHub issues](https://github.com/opengeospatial/ogcapi-routes/issues),
so browse there to get a good idea of what is happening, as well as past decisions.
## Additional information
This repository contains draft content for both:
* [OGC API - Routes - Part 1: Core](https://docs.ogc.org/DRAFTS/21-000.html)
* [OGC Route Exchange Model](https://docs.ogc.org/DRAFTS/21-001.html)
## Building
To generate the HTML versions of the standards from this repository yourself, ensure that you have [Ruby](https://www.ruby-lang.org/en/) and
[Asciidoctor](https://asciidoctor.org/) set up and [installed](https://asciidoctor.org/docs/#get-started-with-asciidoctor).
Then run:
```bash
asciidoctor api/standard/21-000.adoc
asciidoctor rem/standard/21-001.adoc
```
The resulting HTML files will be built in the same directory as the AsciiDoc file, e.g. as `api/standard/21-000.html`.
## Contributing
The contributor understands that any contributions, if accepted by the OGC Membership, shall be incorporated into OGC standards documents and that all copyright and intellectual property shall be vested to the OGC.
The OGC Routing Standards Working Group (SWG) is the group at OGC responsible for the stewardship of the standard, but is working to do as much work in public as possible.
* [Open issues](https://github.com/opengeospatial/ogcapi-routes/issues)
* [Copy of License Language](https://raw.githubusercontent.com/opengeospatial/ogcapi-routes/master/api/LICENSE)
For more information, see [CONTRIBUTING.md](CONTRIBUTING.md).
Pull Requests from contributors are welcomed. However, please note that by sending a Pull Request or Commit to this GitHub repository, you are agreeing to the terms in the Observer Agreement https://portal.ogc.org/files/?artifact_id=96216