search

senzing-garage / senzing-rest-api-specification

OpenAPI specification of Senzing REST API.
Apache License 2.0
0 stars 2 forks source link
resource senzing-app-server

readme

senzing-rest-api-specification

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

Overview

The Senzing REST API specification is an OpenAPI 3.0 Specification of the RESTful API supported by the Senzing API server.

View (Latest version)

Viewing the Senzing REST API OpenAPI specification:

  1. In Swagger UI
  2. In Swagger validator
  3. In Swagger editor

  4. Using Docker. Example:

    sudo docker run \
  --env URL=https://raw.githubusercontent.com/senzing-garage/senzing-rest-api-specification/main/senzing-rest-api.yaml \
  --name senzing-swagger-ui \
  --publish 9180:8080 \
  --rm \
  swaggerapi/swagger-ui

    Open browser to localhost:9180

  5. In GitHub

View (Previous Versions)

View previous versions of the Senzing REST API OpenAPI specification:

Submitting comments

Please create an issue for any requests for clarification or change.