A self-describing API
summary
A small PHP library generates Swagger/OpenAPI specs from controllers that implement a single interface and a static getSwaggerPaths method, letting a CI pipeline generate Swagger/OpenAPI from PHP controllers and fail on inconsistencies; the generator scans directories, supports reference resolvers for shared schemas, emits YAML/JSON, and drives swagger-codegen to produce docs and SDKs automatically. Installation is via Composer with a dev-only generator package, it is open source on GitHub and currently beta. integration via Composer and CI pipeline
AI-written summary · about
chapters (21)
- 0:00Start
- 2:55NFS - the Need For Standard
- 5:15Let me choose one
- 6:23What exactly is OpenAPI?
- 7:16How does it look like?
- 8:05Then what is Swagger?
- 9:32OpenAPI is not perfect
- 12:49What if we write API specs right there in the code?
- 15:05What is Swagger Generator?
- 17:21Open source?
- 18:49What next?
- 19:48How do I describe endpoints for Swagger Generator?
- 21:00Endpoints description examples (array vs 00-style)
- 22:09Complex types and OpenAPI Schema
- 23:39Defining and reusing a complex type
- 24:46Request/ response formats
- 25:18Using Jsend as request/response format
- 26:41Meta information
- 27:01Further automation
- 28:15Microservices? Update dependencies automagically
- 28:56Questions?
related talks
33mDocumenting REST APIs with Swagger
43mUse an API contract for testing and development!
19mSecure and accelerate APIs' lifecycle with the OpenAPI specification
43mAPI first with Swagger and Scala
40mOpenAPI Generator: 4000 stars on GitHub and spaghetti
47mCode generation From API Swagger Yaml schema to PowerShell module in 4 easy steps
39mAPI Development in 2017
46mOpenAPI & .NET: You're Doing It Wrong!