Skip to content

Commit f025dda

Browse files
committed
merged
2 parents 1644956 + ca46405 commit f025dda

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,15 @@
55
## Overview
66
This is the swagger codegen project, which allows generation of client libraries automatically from a Swagger-compliant server.
77

8-
## What's Swagger?
9-
10-
The goal of Swagger™ is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via Swagger, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, Swagger removes the guesswork in calling the service.
11-
12-
138
Check out [Swagger-Spec](https://github.com/swagger-api/swagger-spec) for additional information about the Swagger project, including additional libraries with support for other languages and more.
149

1510

16-
## Compatability
11+
## Compatibility
1712
The Swagger Specification has undergone 3 revisions since initial creation in 2010. The swagger-codegen project has the following compatibilies with the swagger specification:
1813

1914
Swagger Codegen Version | Release Date | Swagger Spec compatibility | Notes
2015
----------------------- | ------------ | -------------------------- | -----
21-
2.1.0 | 2015-06-09 | 1.0, 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-codegen)
16+
2.1.0 | 2015-06-09 | 1.0, 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-codegen)
2217
2.0.17 | 2014-08-22 | 1.1, 1.2 | [tag v2.0.17](https://github.com/swagger-api/swagger-codegen/tree/v2.0.17)
2318
1.0.4 | 2012-04-12 | 1.0, 1.1 | [tag v1.0.4](https://github.com/swagger-api/swagger-codegen/tree/swagger-codegen_2.9.1-1.1)
2419

@@ -29,6 +24,17 @@ You need the following installed and available in your $PATH:
2924
* [Java 7](http://java.oracle.com)
3025

3126
* [Apache maven 3.0.3 or greater](http://maven.apache.org/)
27+
28+
#### OS X Users
29+
Don't forget to install Java 7. You probably have 1.6 or 1.8.
30+
31+
Export JAVA_HOME in order to user proper Java version:
32+
```
33+
export JAVA_HOME=`/usr/libexec/java_home -v 1.7`
34+
export PATH=${JAVA_HOME}/bin:$PATH
35+
```
36+
37+
#### Building
3238

3339
After cloning the project, you can build it from source with this command:
3440

0 commit comments

Comments
 (0)