AI-Driven API Design
Published by O'Reilly Media, Inc.
From vocabulary to documentation and testing
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
Course description
Join expert Mike Amundsen to discover how to integrate AI-assisted automation into human-driven API design, and how to leverage AI tools like ChatGPT to optimize the design, documentation, and testing of web APIs. You’ll understand how to leverage AI to generate structured API documentation, automate security profiling, and produce comprehensive API test scripts, significantly improving efficiency and accuracy. You’ll see real-world exercises, including AI-assisted vocabulary extraction, OpenAPI generation, and automated test scripting, to gain practical experience in AI-powered API development.
What you’ll learn and how you can apply it
- Learn how AI can assist in API development, from design to testing
- Explore methods for extracting API vocabulary using AI from user stories
- Discover how to generate OpenAPI specifications with minimal manual effort
- Understand techniques for automating the creation of human-friendly API documentation
- Learn how AI can assist in identifying security risks and generating security profiles
- Discover best practices for using AI-generated API test scripts
- Understand how to integrate AI-driven automation into an API development workflow
This live event is for you because...
- You’re a software engineer or API developer looking to automate API design and documentation.
- You’re a product manager or architect working on AI-enhanced API-driven products.
Prerequisites
- Knowledge of HTTP, JavaScript
- Experience working with APIs
Recommended follow-up:
- Read RESTful Web API Patterns and Practices Cookbook (book)
- Explore API Design Methodology (on-demand course)
- Take Getting Started with LangChain (live online course with Lucas Soares)
Schedule
The time frames are only estimates and may vary according to how the class is progressing.
Introduction to AI in API design (25 minutes)
- Presentation: Overview of API as interface programming; the role of AI as an intelligent support tool; how AI can enhance API development efficiency; exploring AI-assisted API tools
AI-driven API vocabulary extraction (30 minutes)
- Presentation: Understanding API user stories; using AI to extract domain-specific vocabulary; defining key API terms and standardizing language; using AI to generate an API vocabulary list
- Break
Generating OpenAPI documents from API vocabulary (25 minutes)
- Presentation: Introduction to OpenAPI specification; using AI to convert vocabulary into OpenAPI schema; validating OpenAPI output for consistency and accuracy; AI-assisted OpenAPI generation
Creating human-readable API documentation (30 minutes)
- Presentation: Best practices for API documentation; using AI to generate clear, structured documentation; refining AI-generated docs for readability; converting OpenAPI into user-friendly docs
- Break
API security profiling with AI (25 minutes)
- Presentation: Understanding API security risks; AI-assisted security profiling based on OpenAPI; defining authentication and authorization requirements; using AI to generate security policy tables
Automating API test script generation (25 minutes)
- Presentation: The role of testing in API reliability; using AI to generate test cases from OpenAPI; validating AI-generated test scripts; AI-generated tests on an API
Summary (20 minutes)
- Presentation: Establishing the role of AI as a toolset for API design; creating API vocabularies with AI tools; generating OpenAPI documents with AI; producing human-readable API documentation; outlining API security profiles and generating API test scripts with AI; next steps
Your Instructor
Mike Amundsen
Internationally known author and speaker Mike Amundsen consults with organizations around the world on network architecture, web development, and the intersection of technology and society. He helps companies capitalize on the opportunities provided by APIs, microservices, and digital transformation.