diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..edf33e53 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +## Pull Requests +Plase make your pull requests are made to the [**`develop_2.0`**](https://github.com/swagger-api/swagger-ui/tree/develop_2.0) branch at this time. + +## Issues +SwaggerUI uses [SwaggerJS](https://github.com/swagger-api/swagger-js) library for many internal operations. If you see errors in +[`swagger-client.js`](lib/swagger-client.js) file, you should probably open the issue in [SwaggerJS](https://github.com/swagger-api/swagger-js) repository. + +Please open issues related to Swagger specifications in [Swagger Specs](https://github.com/swagger-api/swagger-spec) repository. diff --git a/README.md b/README.md index 34241625..67e6b88f 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ The Swagger Specification has undergone 4 revisions since initial creation in 20 Swagger UI Version | Release Date | Swagger Spec compatibility | Notes | Status ------------------ | ------------ | -------------------------- | ----- | ------ -2.1.5-M1 | 2015-02-18 | 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-ui) | +2.1.1-M2 | 2015-04-16 | 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-ui) | 2.0.24 | 2014-09-12 | 1.1, 1.2 | [tag v2.0.24](https://github.com/swagger-api/swagger-ui/tree/v2.0.24) | 1.0.13 | 2013-03-08 | 1.1, 1.2 | [tag v1.0.13](https://github.com/swagger-api/swagger-ui/tree/v1.0.13) | 1.0.1 | 2011-10-11 | 1.0, 1.1 | [tag v1.0.1](https://github.com/swagger-api/swagger-ui/tree/v1.0.1) | @@ -53,6 +53,7 @@ docker run -p 127.0.0.1:8080:8080 swagger-ui-builder ``` This will start Swagger UI at `http://localhost:8080`. + ### Use Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstore.swagger.io/v2/swagger.json) service and show its APIs. You can enter your own server url and click explore to view the API. @@ -60,7 +61,7 @@ Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstor You may choose to customize Swagger UI for your organization. Here is an overview of whats in its various directories: - dist: Contains a distribution which you can deploy on a server or load from your local machine. -- dist/lang: The swagger localisation +- dist/lang: The swagger localization - lib: Contains javascript dependencies which swagger-ui depends on - node_modules: Contains node modules which swagger-ui uses for its development. - src @@ -72,12 +73,12 @@ You may choose to customize Swagger UI for your organization. Here is an overvie To use swagger-ui you should take a look at the [source of swagger-ui html page](https://github.com/swagger-api/swagger-ui/blob/master/dist/index.html) and customize it. This basically requires you to instantiate a SwaggerUi object and call load() on it as below: ```javascript - var swaggerUi = new SwaggerUi({ - url:"http://petstore.swagger.io/v2/swagger.json", - dom_id:"swagger-ui-container" - }); +var swaggerUi = new SwaggerUi({ + url:"http://petstore.swagger.io/v2/swagger.json", + dom_id:"swagger-ui-container" +}); - swaggerUi.load(); +swaggerUi.load(); ``` ##### Parameters @@ -147,8 +148,8 @@ To append new lexemex for translation you shoul do two things: 2. Mark this lexeme in source html with attribute data-sw-translate. Example of changed source: ```html - new sentence - or +new sentence +or ``` . @@ -219,7 +220,7 @@ Only headers with these names will be allowed to be sent by Swagger-UI. Create your own fork of [swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui) -To share your changes, [submit a pull request](https://github.com/swagger-api/swagger-ui/pull/new/master). +To share your changes, [submit a pull request](https://github.com/swagger-api/swagger-ui/pull/new/develop_2.0). ## Change Log Plsee see [releases](https://github.com/swagger-api/swagger-ui/releases) for change log.