Leveraging Prompt Engineering for Effective OpenAPI Descriptions of APIs
summary
Uses ChatGPT and GitHub Copilot inside VS Code to generate developer personas, empathy maps and customer journeys, then auto-produces initial OpenAPI drafts and Spring Boot stubs via OpenAPI Generator. Recommends Problem+JSON for errors and HAL+JSON for payloads, pushes organization-specific models (TypeSpec/TypeScript) into a private LLM, and auto-creates test cases and Gherkin specs for positive and negative paths. Claims reviews can be automated in CI to block bad designs and improve developer productivity. TypeSpec
AI-written summary · about
chapters (17)
- 0:00Introduction to talk
- 1:07API lifecycle overview
- 3:34Understanding API needs
- 5:17Prompting for personas
- 7:48Design thinking with AI
- 9:57User personas for APIs
- 11:41Gathering user data
- 13:10Domain-specific API languages
- 15:41Enterprise AI for API design
- 18:13First draft review process
- 20:00AI-assisted API validation
- 22:46Automating API review
- 23:51API implementation guidance
- 25:18Developer productivity with AI
- 26:25AI-generated test cases
- 28:10Future of API testing
- 29:14Conclusion and Q&A
related talks
28mBoost your development workflow with AI
50mContract-Driven Development
40mAPI Lifecycle: Smarter Design and Governance With Open Tooling
27mGetting developers hooked on your API
37mAutomation++ - Building an Enterprise API Economy from scratch
30mOne Spec to Rule them all - OpenAPI in Action
35mAPI-First! Contract-First! Make API development great again!
26mAPI Governance: The Latest Trends Making Teams Love API Standardization.