Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Preparing for the future of API Description Lan...

Preparing for the future of API Description Languages

API Description languages come and go. At Apiary we’ve supported nearly 4 formats without significantly changing our code base. In this session we will talk about how we’ve prepared Apiary for the future of API Description languages. We will cover the evolving domain of API Description, including the new features and concepts introduced in OAS3.

Kyle Fuller

May 16, 2018
Tweet

More Decks by Kyle Fuller

Other Decks in Technology

Transcript

  1. Agenda • Evolu'on of formats in Apiary • How we

    tackled suppor'ng mul'ple formats • Our plan for suppor'ng OAS 3 • Differences between Swagger 2 and OAS 3 © Oracle Corpora,on UK Limited, 2018 4
  2. API Elements { "element": "httpResponse", "attributes": { "statusCode": { "element":

    "number", "content": 200 } }, "content": [...] } © Oracle Corpora,on UK Limited, 2018 23
  3. API Elements { "element": "httpResponse", "attributes": { "statusCode": { "element":

    "number", "content": 200 } }, "content": [...] } © Oracle Corpora,on UK Limited, 2018 24
  4. API Elements { "element": "string", "attributes": { "sourceMap": { "element":

    "sourceMap", "content": [5, 10] } }, "content": "Hello World" } © Oracle Corpora,on UK Limited, 2018 25
  5. OAS 3: Changes • Swagger -> OpenAPI • GitHub-flavoured Markdown

    -> CommonMark • YAML • 2.0 -> 3.0 © Oracle Corpora,on UK Limited, 2018 33
  6. OAS 3: JSON Schema • Larger JSON Schema support •

    oneOf, anyOf, not, and more • nullable (x-nullable extension in Swagger 2) © Oracle Corpora,on UK Limited, 2018 34
  7. A Visual Guide to What's New in Swagger 3.0 4

    4 h$ps:/ /blog.readme.io/an-example-filled-guide-to-swagger-3-2/ © Oracle Corpora,on UK Limited, 2018 36
  8. A Visual Guide to What's New in Swagger 3.0 4

    4 h$ps:/ /blog.readme.io/an-example-filled-guide-to-swagger-3-2/ © Oracle Corpora,on UK Limited, 2018 37
  9. A Visual Guide to What's New in Swagger 3.0 4

    4 h$ps:/ /blog.readme.io/an-example-filled-guide-to-swagger-3-2/ © Oracle Corpora,on UK Limited, 2018 38
  10. A Visual Guide to What's New in Swagger 3.0 4

    4 h$ps:/ /blog.readme.io/an-example-filled-guide-to-swagger-3-2/ © Oracle Corpora,on UK Limited, 2018 39
  11. A Visual Guide to What's New in Swagger 3.0 4

    4 h$ps:/ /blog.readme.io/an-example-filled-guide-to-swagger-3-2/ © Oracle Corpora,on UK Limited, 2018 40