AI-Driven API Design ( Part 2)

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 the 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.

Course 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. 

Extending your AI-Driven API Design Experience

  Part 1 Quick Review

  API Design Basics

  AI Prompt Engineering

  Authoring API Stories

  Generating ALPS Design Docs

  Generating OpenAPI Documents

  Generating API Documentation

  What are Docs?

  Who uses them?

  Basic Elements of API Docs

  Exercise: Generate starter documentation

  Generating a Working Prototype

  What is a Prototype?

  Why use them?

  Prototype Essentials

  Exercise: Generate a NodeJS prototype

  Generating API Tests

  "Outside-In" testing

  Validating inputs/outputs

  Confirming Interface Behavior

  Exercise: Generating API Tests

  Generating Security Profiles

  API Security Basics

  RBAC to the rescue

  Modifying Existing Design Assets

  Exercise: Update Story, Generate Profile, regenerate, other assets

  Course Review and Next Steps

  Review Part 1 (design, AI, ALPS, & OpenAPI)

  Review Part 2 (docs, code, tests, & security)

  What Next?