dwyl / dwyl/learn-api-design

Swagger (OpenAPI Spec) ?

Open
#20 0 comments 0 reactions 0 assignees View on GitHub
help wanted question
Dominant language
No language data
Stars
896
Forks
121
PR merge metrics
No merged PRs in 30d

Description

Should we use Swagger (OpenAPI Spec) to ("self") Document our API?

> https://openapis.org/specification
- Swagger, Blueprint or RAML? http://apievangelist.com/2014/01/16/api-design-do-you-swagger-blueprint-or-raml/
- Comparing API Blueprint vs RAML vs Swagger:
http://modeling-languages.com/modeling-web-api-comparing/
- Quick Start Guide (Slides): http://www.slideshare.net/gakhov/swagger-quick-start-guide
- Consuming Restful APIs using Swagger v2.0 (Slideshow): http://www.slideshare.net/nikolovskipece/consuming-restful-apis-using-swagger-v20 (_Java-focussed_)
- for Hapi-based apps: https://github.com/glennjones/hapi-swagger

> HackerNews Discussion: "**_What's the best way to write an API spec?**_"
> https://news.ycombinator.com/item?id=8912897
> No _clear_ winner.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.