AI-Driven API Design Workshop

From Vocabulary to Documentation and Testing

This workshop teaches you how to leverage AI tools like ChatGPT, Claude, Gemini, etc. 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 course, 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.

Course Outcomes

• Utilize AI tools to extract structured API vocabulary from user stories.
• Generate valid OpenAPI documentation using AI assistance.
• Convert OpenAPI specifications into human-readable API documentation.
• Define and assess security policies for APIs using AI-generated insights.
• Generate and validate automated API test scripts with AI support.

Target Audience

• Software Engineers & API Developers looking to automate API design and documentation.
• Product Managers & Architects working on AI-enhanced API-driven products.

Prerequisites

• Knowledge of HTTP, JavaScript
• Understanding of and experience working with APIs

Level: Beginner to Intermediate