Nutritious Pumpkin Meal

    This package has been deprecated

    Author message:

    Swagger-Server is no longer supported or maintained

    swagger-server-samples

    1.0.0 • Public • Published

    Swagger Server Samples

    Sample REST APIs for Swagger Server

    v1.0.0 Alpha Notice !
    Swagger Server v1.0.0 is still in alpha, and we're still working on the samples, documentation, and walkthroughs. The v1.0 API isn't totally solidified yet, so the samples may still change.

    Installation

    Install the samples using npm:

    npm install swagger-server-samples

    Running the Samples

    To run any of the samples, open the swagger-server-samples directory in a command prompt, and then run the sample using the npm run command, like this:

    cd path/to/swagger-server-samples
    npm run sample1

    All of the samples run on port 8000, so open your web browser and go to http://localhost:8000

    Sample 1

    Sample 1 runs the Swagger Pet Store REST API, which lets you manage a simple list of pets. You can add, edit, and delete pets, search for pets using query strings, and even upload photos of pets.

    This sample demonstrates the most simplistic usage of Swagger Server. All functionality is provided automatically by the Swagger Server mocks. There's no custom code at all.

    Sample 2

    Sample 2 builds on top of Sample 1. It uses the same Swagger Pet Store REST API, but demonstrates a few advanced features of Swagger Server, such as setting options, loading mock data, and adding custom middleware logic.

    Sample 3

    Sample 3 is a completely different beast than the first two samples. It uses a completely different REST API that is spread out over several different YAML files. The API is a company directory with employees and project assignments. You can add, edit, and delete employees and projects. You can also assign or remove employees to/from projects.

    This sample contains much more custom JavaScript logic than the previous samples, including custom authentication, permissions, and business logic. There are some operations that can only be performed by admin users, and other operations that can be performed by any user, but only on their own data.

    Install

    npm i swagger-server-samples

    DownloadsWeekly Downloads

    14

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • bigstickcarpet
    • rkrauskopf
    • jamesmessinger