https://github.com/googlemaps/openapi-specification

OpenAPI specification for Google Maps Platform API
https://github.com/googlemaps/openapi-specification

google google-maps openapi

Last synced: about 1 month ago
JSON representation

OpenAPI specification for Google Maps Platform API

• Host: GitHub
• URL: https://github.com/googlemaps/openapi-specification
• Owner: googlemaps
• License: apache-2.0
• Created: 2021-02-12T17:04:44.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-05T08:55:28.000Z (5 months ago)
• Last Synced: 2024-08-07T08:14:58.656Z (5 months ago)
• Topics: google, google-maps, openapi
• Language: TypeScript
• Homepage:
• Size: 22.7 MB
• Stars: 100
• Watchers: 10
• Forks: 84
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Google Maps Platform OpenAPI3 Specification

![Build](https://github.com/googlemaps/openapi-specification/workflows/Test/badge.svg)

![Release](https://github.com/googlemaps/openapi-specification/workflows/Release/badge.svg)

![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/openapi-specification?color=green)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-flat.png)](https://github.com/apps/in-solidarity)

## Description

An OpenAPI specification for Google Maps Platform APIs.

| API                | Status       |

| ------------------ | ------------ |

| Elevation          | **Complete** |

| GeoCoding          | **Complete** |

| GeoLocation        | **Complete** |

| Distance           | **Complete** |

| Roads              | **Complete** |

| Time Zone          | **Complete** |

| Directions         | **Complete** |

| Places             | **Complete** |

| Street View        | **Complete** |

| Maps Static        | Not Started  |

> **Note**: New APIs will be documented using Google Discovery documents and Protobuf files.

[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/13440387-fc4788d5-77f9-4639-a4c5-74a2878d7eb5?action=collection%2Ffork&collection-url=entityId%3D13440387-fc4788d5-77f9-4639-a4c5-74a2878d7eb5%26entityType%3Dcollection%26workspaceId%3D047c6f75-6b23-42df-b77a-70d716895d9f)

## Development

The repository makes use of [Bazel](https://bazel.build/) to generate outputs from the specification and sample requests.

### Build and test

1. `npm i`

1. `npm run build`

    This generates the following outputs in the dist folder:

    - YAML file containing OpenAPI3 specification

    - JSON file containing OpenAPI3 specification

    - Structure Markdown documents for specification objects

    - Code snippets in multiple languages for sample requests

    > **Note**: There is a bot that can be triggered in a pull request with a comment containing `/update-dist`. See the workflow at https://github.com/googlemaps/openapi-specification/blob/main/.github/workflows/command.yml.

    > **Note**: The `dist/` folder is included in this repo and should be updated with all changes.

    > **Note**: If a documentation item is not generated, be sure it is included

    in the appropriate index.yml file.

1. `npm run responses` (optional)

    > **Note**: This is an optional step requiring an API key. Set the `GOOGLE_MAPS_API_KEY` environmental variable before running.

    > **Note**: This step only needs to run when the generation code or sample requests have been updated.

    > **Note**: The geolocation request that only provides an IP is not deterministic and skipped in the binary executed.

    > **Note**: A single response can be updated similar to `npm run responses -- --only maps_http_places_nearbysearch`.

1. `npm run test`