Skip to content

API Usage

Cory Gehr edited this page Apr 24, 2020 · 1 revision

Swagger

Due to the fast pace of development, it is easiest to use the Swagger documentation generated when compiling and running this project.

When running locally, the Swagger UI can be accessed via https://localhost:44347/swagger.

Versioning

Requests will always assume the latest API version by default. Versions are based on the date a proto change was proposed using the format YYYY-MM-DD. Applications can request specific API versions with the api-version query parameter. For example, to access API version 2020-04-15, the request should be formatted as:

https://localhost:44347/api/Message?api-version=2020-04-15

To avoid breaking changes to applications, please always provide this query parameter.

Available versions

API requests will always return the following headers to convey version information:

  • api-supported-versions
    • API versions which are supported by a request.
  • api-deprecated-versions
    • Old API versions which may disappear in future updates.

Contents

  1. Home

Deployment

  1. Quickstart

Usage

  1. API Usage
  2. Content Formatting

Advanced Topics

  1. Changing DBMS
  2. Load Balancing

Clone this wiki locally