Skip to content
/ api Public

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

License

Notifications You must be signed in to change notification settings

Chatie/api

Repository files navigation

Chatie Restful API

OpenAPI Specification Schema Validation

Open API 3 Specification

Credit: Icon Library

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

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

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

OAS3 Generators

Spec/Design Driven Development Tools:

Toolsets

See Also

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

Author

Huan LI (李卓桓), Tencent TVP of Chatbot, <[email protected]>

Profile of Huan LI (李卓桓) on StackOverflow

Copyright & License

  • Code & Docs © 2017-now Huan LI <[email protected]>
  • Code released under the Apache-2.0 License
  • Docs released under Creative Commons

About

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

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published