2023/03/28 Ruby Jam 3 月場 @cafedomancer Schema-first API Development with OpenAPI and Committee

Introduction

Shohei Umemoto Hokkaido, Japan Rails, Next.js, Flutter Enishi Tech Inc. Fjord Boot Camp

Pocco Popsicles for children Ingredients from Hokkaido App: + API: Interacting by REST API

Schema-first

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

Schema-first Web API Development Backend 1. Schema 🤝 2. Develop 3. Verify 4. Release Frontend 1. Schema 🤝 2. Develop 3. Verify 4. Release

How-to

OpenAPI Specification (OAS) Web API specification written in YAML or JSON Useful tools for OAS, like Swagger Editor, Swagger UI, Swagger Codgen

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

Demonstration

cafedomancer/petstore https://github.com/cafedomancer/petstore

Conclusion

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

Thanks for listening Taiwan: Any conferences? Japan: RubyKaigi! Let's talk in Chinese, Japanese, English 🤣