Chatie/api

Chatie Restful API, Powered by OpenAPI Specifiction(f.k.a. Swagger)

Chatie Restful API

Credit: Icon Library

Chatie Restful API, Powered by OpenAPI Specifiction(f.k.a. Swagger)

• Swagger Editor Online
• Swagger Generator

Motivation

Describe our RESTful APIs in OpenAPI Specification, which is an Interface Description Language under Linux Foundation, former Swagger. We believe our API will be improved greatly after the specification has been implemented.

Princinples: Spec-Driven Development

• What is Spec Driven Development
• Building Your API for Longevity, Part 1: Spec-Driven Development

Code Generator

We can generate both server and client code from OpenAPI Specification file.

Server

cd server
../node_modules/.bin/yo swaggerize --framework=express --apiPath=../spec/swagger.yaml

Client

gRPC to OpenAPI Specification

• gRPC to JSON proxy generator following the gRPC HTTP spec (talk video)

OAS3 Generators

Spec/Design Driven Development Tools:

• horiuchi/dtsgenerator - TypeScript d.ts file generate from JSON Schema file
• openapitools/openapi-generator - Generator for server stubs for OpenAPI Spec v3 (writen in Java)
• swagger-api/swagger-codegen - a template-driven engine to generate server stubs by parsing your OpenAPI / Swagger definition
• Mermade/openapi-codegen - OpenAPI 3.0 CodeGen plus Node.js minus the Java and emojis
• fmvilas/swagger-node-codegen

Toolsets

• cdimascio/express-openapi-validator - Auto-validates api requests, responses, and securities using ExpressJS and an OpenAPI Specification 3

See Also

• OpenAPI/Swagger-generated API Reference Documentation
• Design Drivin API Development
• OpenAPI Initiative
• Swagger Server Sample 3
• Swaggerize Examples
• The Anatomy of a JSON Web Token
• Authenticate a Node.js API with JSON Web Tokens
• An Introduction to OAuth 2
• Design Driven Development
• Intro to RAML - API Spec Driven Development
• LoopBack - Defining the API using code-first approach
• LoopBack - OpenAPI generator
• OpenAPI.Tools

History

master

0.1 Apr 20, 2020

1. Upgrade Spec from Swagger 2.0 to OpenAPI 3.0 with the help of Mermade Swagger 2.0 to OpenAPI 3.0.0 converter #2
2. Enable DevOps Tools

0.0.1 Feb 19, 2017

Initial version

• Add Swagger Online Editor
• Add Redocly Online Viewer
• Add OpenAPI Specification Schema Validation

Author

Huan LI (李卓桓), Tencent TVP of Chatbot, <zixia@zixia.net>

Copyright & License

• Code & Docs © 2017-now Huan LI <zixia@zixia.net>
• Code released under the Apache-2.0 License
• Docs released under Creative Commons