Authentication

Security is one of the main features of building an API. With APICHAP you are able to integrate your authentication protocols into your API.

Roadmap: We are constantly expanding the list of supported authentication methods. Connect with us, if your method is missing Contact.

No Authentication

Due to security reasons the authentications key must also be present if you are not using any authentication.

authentications: {}

Basic Auth

Define a user and password combination to secure your service with Basic Auth.

authentications:
  NAME_OF_YOUR_AUTH:
    type: basicauth
    user: default
    password: generatedpwd

Bearer Token

Coming Soon.

oAuth 2.0

Coming Soon

Custom Authentication

Apart from using an authentication standard it is always possible to handle the authentication and security yourself. By creating fulfillments in your endpoint accordingly.

Important

The API Documentation UI Page is excluded from authentication: If you want to disable your Swagger UI Page, disable debug mode. All API Documentation specific URLs like /swagger-ui and /v3/api-docs/** are not authenticated.