You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-16Lines changed: 28 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,13 +13,12 @@ The goal of Swagger™ is to define a standard, language-agnostic interface to R
13
13
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.
14
14
15
15
16
-
17
16
## Compatability
18
17
The Swagger Specification has undergone 3 revisions since initial creation in 2010. The swagger-codegen project has the following compatibilies with the swagger specification:
19
18
20
19
Swagger Codegen Version | Release Date | Swagger Spec compatability | Notes
Great for creating libraries on your ci server, from the [Swagger Editor](http://editor.swagger.io)... or while coding on an airplane.
@@ -110,12 +114,20 @@ Great for creating libraries on your ci server, from the [Swagger Editor](http:/
110
114
There are different aspects of customizing the code generator beyond just creating or modifying templates. Each language has a supporting configuration file to handle different type mappings, etc:
111
115
112
116
```
113
-
$ ls -1 src/main/java/com/wordnik/swagger/codegen/languages/
117
+
$ ls -1 modules/swagger-codegen/src/main/java/com/wordnik/swagger/codegen/languages/
114
118
AndroidClientCodegen.java
115
119
JavaClientCodegen.java
116
120
JaxRSServerCodegen.java
121
+
NodeJSServerCodegen.java
117
122
ObjcClientCodegen.java
123
+
PhpClientCodegen.java
124
+
PythonClientCodegen.java
125
+
ScalaClientCodegen.java
126
+
ScalatraServerCodegen.java
118
127
StaticDocCodegen.java
128
+
StaticHtmlGenerator.java
129
+
SwaggerGenerator.java
130
+
TizenClientCodegen.java
119
131
```
120
132
121
133
Each of these files creates reasonable defaults so you can get running quickly. But if you want to configure package names, prefixes, model folders, etc., you may want to extend these.
To do so, just use the `-l dynamic-html` flag when reading a spec file. This creates HTML documentation that is available as a single-page application with AJAX. To view the documentation:
154
166
155
167
```
156
-
cd samples/swagger-dynamic-html/
168
+
cd samples/dynamic-html/
157
169
npm install
158
170
node .
159
171
```
@@ -166,7 +178,7 @@ Which launches a node.js server so the AJAX calls have a place to go.
166
178
To do so, just use the `-l html` flag when reading a spec file. This creates a single, simple HTML file with embedded css so you can ship it as an email attachment, or load it from your filesystem:
167
179
168
180
```
169
-
cd samples/swagger-html/
181
+
cd samples/html/
170
182
open index.html
171
183
```
172
184
@@ -177,7 +189,7 @@ You can also use the codegen to generate a server for a couple different framewo
0 commit comments