https://github.com/Cimpress/swagger-ui-cimpress

A swagger-ui fork with an easy to read, responsive three pane view.
https://github.com/Cimpress/swagger-ui-cimpress

developer-experience developer-tools swagger swagger-docs swagger-ui

Last synced: 5 months ago
JSON representation

A swagger-ui fork with an easy to read, responsive three pane view.

• Host: GitHub
• URL: https://github.com/Cimpress/swagger-ui-cimpress
• Owner: Cimpress
• License: other
• Archived: true
• Created: 2016-07-12T18:56:49.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-10-17T15:52:17.000Z (over 7 years ago)
• Last Synced: 2024-04-29T17:07:29.060Z (12 months ago)
• Topics: developer-experience, developer-tools, swagger, swagger-docs, swagger-ui
• Language: CSS
• Homepage: https://developer.cimpress.io/swagger-ui/index.html
• Size: 18.1 MB
• Stars: 32
• Watchers: 8
• Forks: 8
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![screenshot](screenshot.png)

# swagger-ui-cimpress

[![Build Status](https://travis-ci.org/Cimpress-MCP/swagger-ui-cimpress.svg?branch=master)](https://travis-ci.org/Cimpress-MCP/swagger-ui-cimpress)

[![NPM version](https://badge.fury.io/js/swagger-ui-cimpress.svg)](http://badge.fury.io/js/swagger-ui-cimpress)

A swagger-ui fork with an easy to read, responsive three pane view. Used on https://developer.cimpress.io.

Swagger UI uses client-side Javascript (jQuery + Backbone) to download a swagger.json resource and make "Try It" requests to the described endpoints. You can learn more about the swagger-ui project at the upstream source: https://github.com/swagger-api/swagger-ui

## Acknowledgement

This is a fork of https://github.com/jensoleg/swagger-ui which is a fork of https://github.com/swagger-api/swagger-ui. There are many differences, including the build process and test definitions.

## Developers

Cimpress employees can deploy builds to Cimpress Open, but first it’s necessary to setup credentials.

    # Install aws-cli and configure credentials to right AWS account

    # For more info, see https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html

    $ pip install awsebcli --upgrade

    $ aws configure

    # Build the project

    $ yarn run build

    # Deploy to 'integration', 'staging', or 'production'

    $ yarn run deploy:integration