Giter VIP home page Giter VIP logo

blueoak-server-petstore's Introduction

BlueOak Server Pet Store

What would the Swagger Pet Store example look like if written with BlueOak?

This.

Things to Notice

  1. the Swagger spec is spread across several files that get joined together on BOS start
  2. $refs in the spec are the relative paths to the files with the details of the desired object
  3. the BOS "$ref compiler" is used to add all definitions, parameters, and responses to the end of the main spec file
    1. because of that, our nodemon.json file is set to ignore .yaml files in the swagger directory
    2. because we're not watching the root spec file for changes, we put as little data there as possible

How to Try

  1. start the server using either npm start or nodemon
  2. take a look at the swagger spec served from http://localhost:3003/swagger/bos-petstore
    1. if you have swagger-commander (do npm i -g swagger-commander if you don't) you can simply run it to explore
    2. if you have swagger-ui to run locally, you can point it to that URl to see it's representation of the spec

blueoak-server-petstore's People

Watchers

Sean Kennedy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.