Stop writing your API clients by hand

Introduction and demo of how one can use the Open API Spec to generate API clients on demand.

Transcript

1. Stop writing your API clients by hand
3. Alan Cooke — Senior Staff Engineer, Mobile
7. Open API aka Swagger — Open standard — Machine readable — Language agnostic approach to API specification
9. Path specification paths: /v2/track: post: operationId: Track summary: Track tags: - Event consumes: - application/json parameters: - name: body in: body schema: $ref: '#/definitions/Event' responses: '200': description: '' security: - X-Outbound-Key: []
10. Model specification definitions: User: title: User type: object properties: user_id: type: string first_name: type: string last_name: type: string email: type: string required: - user_id
11. Security schemes securityDefinitions: X-Outbound-Key: name: X-Outbound-Key type: apiKey in: header
12. Tooling — Open source tools — Node service you run locally or hosting service, allows you edit and mock APIs — Commercial tooling — Stoplight.io
13. Code generators — Open Source repo: https://github.com/swagger-api/ swagger-codegen/ Project broken into two parts 1. Command Line Interface - swagger-codegen-cli 1. Code generator - swagger-codegen
14. Writing your own generator 1. Java class, allows you todo any special pre/post processing of models 2. Collection of mustache template files used to translate model into code
15. public struct {{classname}}: Codable { {{#allVars}} {{#description}}/** {{description}} */ {{/description}}public var {{name}}: {{{datatype}}} {{^required}}?{{/required}} {{#defaultValue}} = {{{defaultValue}}}{{/defaultValue}} {{/allVars}} }
17. Demo
18. Questions