Schema-first API Development with OpenAPI and Committee

Transcript

1. 2023/03/28 Ruby Jam 3 月場 @cafedomancer Schema-first API Development with OpenAPI and Committee
2. Introduction
3. Shohei Umemoto Hokkaido, Japan Rails, Next.js, Flutter Enishi Tech Inc. Fjord Boot Camp
4. Pocco Popsicles for children Ingredients from Hokkaido App: + API: Interacting by REST API
5. Schema-first
6. NOT Schema-first (Schema-last?) Web API Development Backend 1. Design 2. Develop 3. Verify 4. Release Frontend 1. Wait 2. Wait 3. Wait 4. Develop 5. Uh-oh
7. Schema-first Web API Development Backend 1. Schema 🤝 2. Develop 3. Verify 4. Release Frontend 1. Schema 🤝 2. Develop 3. Verify 4. Release
8. How-to
9. OpenAPI Specification (OAS) Web API specification written in YAML or JSON Useful tools for OAS, like Swagger Editor, Swagger UI, Swagger Codgen
10. Committee and Committee::Rails Committee: Rack middleware to validate requests and responses along with OAS Committee::Rails: Rails integration to utilize assertions like - assert_request_schema_confirm - assert_response_schema_confirm
11. Demonstration
12. cafedomancer/petstore https://github.com/cafedomancer/petstore
13. Conclusion
14. Pros and Cons Pros: No outdated specification and documentation Pros: Promote collaborating and reduce reworking Cons: Learn about OpenAPI Specification Cons: Committee doesn't always cover every cases
15. Thanks for listening Taiwan: Any conferences? Japan: RubyKaigi! Let's talk in Chinese, Japanese, English 🤣