Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Server integration
    1. generating the swagger json on-the-fly. our REST api includes ".../api" endpoint to generate the json.
    2. It means that you need to add api documentation at your code by using annotation 
  2. No server integration
    1. generating the swagger json file manually or 
    2. generating the json automatically in compilation (build) by using 3rd party tools
      1. it can use same annotations mentioned #1 above, javadocs or JAX-RS annotation
  3. Brown Dog API - utilizing Swagger: https://bd-api-dev.ncsa.illinois.edu/docs/

Testing

Currently, BrownDog uses mostly Java and Scala to create REST API. We will test these languages and preferred-library first. The test results and notes will be posted here.

...