liveBook · Manning

Swagger Editor Next

As explained in Building Web APIs with ASP.NET Core

A web-based editor for creating, viewing, validating, and generating artifacts from Swagger API definitions.

Swagger Editor is a web-based editor for viewing Swagger definitions, rendering their API documentation in real time, and generating client artifacts without local installation. section 12.1.4

Use it to turn an existing API definition into static documentation:

  • Run the MyBGList project in Debug mode and open its Swagger UI dashboard. section 12.1.4
  • Open the swagger.json link, save the API definition locally, and import it through File > Import File. section 12.1.4
  • Choose Generate Client > HTML2 to download a ZIP archive containing the generated HTML file. section 12.1.4

How Building Web APIs with ASP.NET Core covers it

How deep it goes
Walks through exporting, importing, and generating HTML, but does not detail the editor’s internal implementation.
Examples
Uses a MyBGList swagger.json file and produces a ZIP archive containing one generated HTML file.
What it assumes
Assumes an available Swagger definition and introduces the export, import, and generation sequence from the interface.
What you can do after
Build static API documentation by importing a Swagger definition and selecting the HTML2 client generator.
How it connects
Connects Swagger definitions with Swagger UI, Swagger Codegen, SwaggerHub, and static API documentation.
Cover of Building Web APIs with ASP.NET Core
liveBookmanning.com
Read Building Web APIs with ASP.NET Core on liveBook Get the book at manning.com

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Building Web APIs with ASP.NET Core. The section links point to the parts of the book it draws on.