AI-Driven API Design ( Part 1)

This pair of presentations (90 mins each) teaches you how to leverage AI tools like ChatGPT to optimize the design, documentation, and testing of web APIs. As AI becomes increasingly crucial in software development, this course will equip you to integrate AI-assisted automation into human-driven API design.

By the end of this two part workshop, you will be able to leverage AI to generate structured API documentation, automate security profiling, and produce comprehensive API test scripts, significantly improving efficiency and accuracy. Participants will see real-world exercises, including AI-assisted vocabulary extraction, OpenAPI generation, and automated test scripting, to gain practical experience in AI-powered API development.

Workshop Objectives:

  How AI can assist in API development, from design to testing.  

  Methods to extract API vocabulary using AI from user stories.  

  How to generate OpenAPI specifications with minimal manual effort. 

  Techniques to automate the creation of human-friendly API documentation. 

  How AI can assist in identifying security risks and generating security profiles.  

  Best practices for using AI-generated API test scripts.  

  How to integrate AI-driven automation into an API development workflow. 

Part 1 : Basics of AI-Driven API Design

  Course Introduction

  Course Outline

  Goals and format

  "Play-along" with the repo

  Design Basics

  Story

  Vocabulary

  Diagram

  Description

  Definition

  AI Prompt / Context Engineering

  Conversation

  Context

  Memory

  Tips

  Authoring API Stories

  Stories are shared understanding

  Parts of an API Story

  Iterating on your API Story

  Exercise: The Task Management API Story

  Generating ALPS Design Docs

  Information Architecture

  Application-Level Profile Semantics

  ALPS Basics

  Exercise: Generating Designs with API Stories

  Generating OpenAPI Documents

  A formal standard for describing HTTP APIs.

  Common way to describe implementations

  Common platform for tooling

  Shared practice for building 

  Exercise: Generating AopenAPI