Authentication to access your API is the first step your customer likely takes before they start retrieving information from your servers. This presentation explains and demonstrates:

  • Authentication and authorization methods, including:
    • Basic authentication
    • Sending an API key
    • OIDC with client credentials
  • Providing a choice of separate authentication server URLs
  • Providing a choice of API server options to access your service, including defining variables in the URL
  • Creating a separate Swagger documentation file dedicated to explaining and accessing your authentication server, which displays your authentication server’s response in more detail.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.

By the end of the presentation, you should be able to add different authentication options to your own Swagger documentation.

This session assumes some knowledge of APIs and documentation with Swagger.

About the Presenter

Hava is a Technical Writer at Carbyne, where she combines her favorite pursuits of writing, graphics and coding. She is responsible for documenting Carbyne’s customer-facing APIs, transforming them into marketable products. She holds degrees in Mathematics and Computer Science and has worked in software development and editing scientific papers in medicine and archaeology.  Hava presented a session at MegaCOMM 2023 on API documentation in Swagger.