Skip to content

Hypermedia Swagger Hack

Arnaud Lauret edited this page Sep 18, 2015 · 2 revisions

#Idea Adding hypermedia definition to swagger definition and render this information with Swagger Tools or custom ones.

#User stories

As an API designer I want:

  • To define hypermedia controls within Swagger definition user vendor extension
  • To use Swagger Editor to write this definition and visualize it.

As a API consumer I want:

  • To see a visual representation of hypermedia (graph for example)
  • To use the hypermedia controls within Swagger UI
  • Add hypermedia controls to an existing API via a proxy and swagger definition defining hypermedia for this API

#What we (Shelby, Bonnie, Dilip, Arnaud) have done on hackday

  • Define hypermedia controls within Swagger definition using a custom extension: x-links containing the operationId corresponding to the controls (swagger.yaml).
  • Customize Swagger UI to render these informations (Github repo)
Clone this wiki locally