Skip to content

API documentation

moattarwork edited this page Dec 14, 2022 · 1 revision

LittleBlocks supports Open API - V3 for API documentation and test. The endpoint is reachable via Http(s)://{API-URL}/swagger. This enables the users and the developers to explore the API in a testable way.

Swagger implementation is configured to automatically attach CORRELATION-ID to each request you make and the Authentication with OAuth2 and ApiKey has been implemented to enable working with secured endpoints.

NOTE: Open API configuration in LittleBlocks needs Application configuration in appsettings.json file for the name of the application and the version

{
  "Application": {
    "Name": "My API",
    "Version": "2.0",
    ...
  }
}
Clone this wiki locally