1
- # NAME
1
+ # { {artifactId } }
2
2
3
3
{ {appName} }
4
-
5
- { {#appDescription} }{ {{appDescription} }}{ {/appDescription} }
6
-
7
- # VERSION
8
-
9
- Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
10
-
11
4
- API version: { {appVersion} }
12
- - Package version: { {moduleVersion} }
13
5
{ {^hideGenerationTimestamp} }
14
- - Build date: { {generatedDate} }
6
+ - Build date: { {generatedDate} }
15
7
{ {/hideGenerationTimestamp} }
16
- - Build package: { {generatorClass} }
8
+
9
+ { {#appDescription} }{ {{appDescription} }}{ {/appDescription} }
10
+
17
11
{ {#infoUrl} }
18
- For more information, please visit [{ {{infoUrl} }}]({ {{infoUrl} }})
12
+ For more information, please visit [{ {{infoUrl} }}]({ {{infoUrl} }})
19
13
{ {/infoUrl} }
20
14
21
- # Requirements
15
+ *Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)*
22
16
23
- Building the API client library requires [Maven](https://maven.apache.org/) to be installed.
17
+ ## Requirements
18
+
19
+ Building the API client library requires:
20
+ 1. Java 1.7+
21
+ 2. Maven/Gradle/SBT
24
22
25
23
## Installation
26
24
27
25
To install the API client library to your local Maven repository, simply execute:
28
26
29
27
```shell
30
- mvn install
28
+ mvn clean install
31
29
```
32
30
33
31
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
34
32
35
33
```shell
36
- mvn deploy
34
+ mvn clean deploy
37
35
```
38
36
39
- Refer to the [official documentation](https ://maven.apache .org/plugins/maven-deploy-plugin/usage .html) for more information.
37
+ Refer to the [OSSRH Guide](http ://central.sonatype .org/pages/ossrh-guide .html) for more information.
40
38
41
39
### Maven users
42
40
43
41
Add this dependency to your project's POM:
44
42
45
43
```xml
46
44
<dependency >
47
- <groupId >{ {{groupId} }}</groupId >
48
- <artifactId >{ {{artifactId} }}</artifactId >
49
- <version >{ {{artifactVersion} }}</version >
50
- <scope >compile</scope >
45
+ <groupId >{ {{groupId} }}</groupId >
46
+ <artifactId >{ {{artifactId} }}</artifactId >
47
+ <version >{ {{artifactVersion} }}</version >
48
+ <scope >compile</scope >
51
49
</dependency >
52
50
```
53
51
@@ -65,13 +63,15 @@ compile "{{{groupId}}}:{{{artifactId}}}:{{{artifactVersion}}}"
65
63
libraryDependencies += "{ {{groupId} }}" % "{ {{artifactId} }}" % "{ {{artifactVersion} }}"
66
64
```
67
65
66
+ ## Getting Started
67
+
68
68
## Documentation for API Endpoints
69
69
70
70
All URIs are relative to *{ {basePath} }*
71
71
72
72
Class | Method | HTTP request | Description
73
73
------------ | ------------- | ------------- | -------------
74
- { {#apiInfo} }{ {#apis} }{ {#operations} }{ {#operation} }*{ {classname} }* | [ **{ {operationId} }**]( { {apiDocPath } } { {classname } }.md# { {operationId } }) | **{ {httpMethod} }** { {path} } | { {#summary} }{ {summary} }{ {/summary} }
74
+ { {#apiInfo} }{ {#apis} }{ {#operations} }{ {#operation} }*{ {classname} }* | **{ {operationId} }** | **{ {httpMethod} }** { {path} } | { {#summary} }{ {summary} }{ {/summary} }
75
75
{ {/operation} }{ {/operations} }{ {/apis} }{ {/apiInfo} }
76
76
77
77
## Documentation for Models
@@ -101,28 +101,6 @@ Class | Method | HTTP request | Description
101
101
102
102
{ {/authMethods} }
103
103
104
-
105
- # BUILDING YOUR LIBRARY
106
-
107
- See the homepage `https://github.com/swagger-api/swagger-codegen` for full details.
108
- But briefly, clone the git repository, build the codegen codebase, set up your build
109
- config file, then run the API build script. You will need git, Java 7 or 8 and Apache
110
- maven 3.0.3 or better already installed.
111
-
112
- Your library files will be built under `WWW::MyProjectName`.
113
-
114
- $ git clone https://github.com/swagger-api/swagger-codegen.git
115
- $ cd swagger-codegen
116
- $ mvn package
117
- $ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
118
- -i [URL or file path to JSON swagger API spec] \
119
- -l akka-scala \
120
- -c /path/to/config/file.json \
121
- -o /path/to/output/folder
122
-
123
- Bang, all done. Run the `autodoc` script in the `bin` directory to see the API
124
- you just built.
125
-
126
104
## Author
127
105
128
106
{ {#apiInfo} }{ {#apis} }{ {^hasMore} }{ {infoEmail} }
0 commit comments