Swagger Play Sample App banner
swagger-api swagger-api

Swagger Play Sample App

Development community

Description

A sample play app which uses swagger plugin to make the age old pet store swagger compliant.

Installation

This entry records only its repository, not the path inside it, so there is no exact command to give. Open the source below and copy the folder into ~/.claude/skills/, or the file into ~/.claude/agents/.

README

Swagger Play Framework Sample App

Overview

This is a project to illustrate use of swagger plugin on play-framework.

Prerequisites

You need the following installed and available in your $PATH:

  • - Play Framework 1.2.4
  • - Scala Plugin (play install scala)
  • - Swagger Core pre-release version
  • - Swagger Play Framework Plugin https://github.com/wordnik/swagger-play
  • - Scala 2.8.1 (http://www.scala-lang.org)

    To build

    Clone swagger-play from https://github.com/wordnik/swagger-play and build it using instructions in the README.md file

    In swagger-play-sample-app, edit conf/dependencies.yml and update the line below to point to your locally cloned (and built) swagger-play. Note! This needs to be an absolute path!

    artifact:   "/path/to/swagger-play"
    

    Build and run swagger-play-sample-app:

    play install scala
    play deps
    play run
    

    Take Swagger UI for a spin

    If you hit http://localhost:9000 you should see swagger-ui (https://github.com/wordnik/swagger-ui) come up for the sample app

    Test API Listing directly

    Open a browser window and confirm you can see API listing by hitting the following URLs

  • - http://localhost:9000/resources.{format} : A list of available resources
  • - http://localhost:9000/help/user.{format} : User Resource API and Models
  • - http://localhost:9000/help/pet.{format} : Pet Resource API and Models
  • - http://localhost:9000/help/store.{format} : Store Resource API and Models