BigstickCarpet/swagger-express-middleware

View on GitHub
docs/walkthroughs/README.md

Summary

Maintainability
Test Coverage
Samples & Walkthroughs
============================

![Screenshot](../img/samples.png)

Sample 1
--------------------------
This sample demonstrates the most simplistic usage of Swagger Express Middleware. It simply creates a new Express Application and adds all of the Swagger middleware without changing any options, and without adding any custom middleware.

* [Source Code](https://github.com/APIDevTools/swagger-express-middleware/blob/master/samples/sample1.js)
* [Walkthrough](running.md)
  * [Running the sample](running.md)
  * [JavaScript Walkthrough](javascript.md)
  * [YAML Walkthrough](yaml.md)


Sample 2
--------------------------
This sample demonstrates a few more advanced features of Swagger Express Middleware, such as setting a few options, initializing the mock data store, and adding custom middleware logic.

* [Source Code](https://github.com/APIDevTools/swagger-express-middleware/blob/master/samples/sample2.js)
* [Walkthrough](walkthrough2.md)
  * [Running the Sample](walkthrough2.md#running-the-sample)
  * [Alternate Syntax](walkthrough2.md#alternate-syntax)
  * [Pre-Populating Mock Data](walkthrough2.md#pre-populated-data)
  * [Case-Sensitive and Strict Routing](walkthrough2.md#case-sensitive-and-strict-routing)
  * [Setting Middleware Options](walkthrough2.md#customized-middleware-options)
  * [Custom Middleware](walkthrough2.md#custom-middleware)