Skip to content

Commit 4b4f4d6

Browse files
rcebrianrcebrian
authored
feat: add template-dir argument for custom templates (#12). Thanks @rcebrian!
1 parent 1dedccb commit 4b4f4d6

24 files changed

+1619
-2
lines changed

‎.github/workflows/checks.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ jobs:
2525
config-file: test_data/config.yml
2626
openapi-file: test_data/openapi.json
2727
- run: cd rust-client
28+
smoke-test-template:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- uses: actions/checkout@v2
32+
- uses: openapi-generators/openapitools-generator-action@v1
33+
with:
34+
generator: rust
35+
config-file: test_data/config.yml
36+
openapi-file: test_data/openapi.json
37+
template-dir: test_data/templates/rust/
38+
- run: cd rust-client
2839
test-openapi-version:
2940
runs-on: ubuntu-latest
3041
steps:

‎README.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ The URL to load the OpenAPI document from. If set, `openapi-file` will be ignore
2323

2424
The Docker tag of the openapitools/openapi-generator-cli image to use. See [the DockerHub repo](https://hub.docker.com/r/openapitools/openapi-generator-cli/tags) for available tags.
2525

26+
### `template-dir`
27+
28+
The path (with respect to the current directory/the workspace) to the folder containing the template files. See user-defined [templates](https://openapi-generator.tech/docs/templating#modifying-templates) via options.
29+
2630
### `command-args`
2731

2832
Additional arguments to pass through to the [generate](https://openapi-generator.tech/docs/usage#generate) command.
@@ -58,3 +62,32 @@ jobs:
5862
run: |
5963
cd typescript-angular-client
6064
```
65+
66+
## Template example usage
67+
```yaml
68+
jobs:
69+
generate-angular-client:
70+
runs-on: ubuntu-latest
71+
name: Example
72+
steps:
73+
74+
# Checkout your code
75+
- name: Checkout
76+
uses: actions/checkout@v2
77+
78+
# Generate your OpenAPI document (if you don't write it manually)
79+
80+
# Use the action to generate a client package
81+
# This uses the default path for the openapi document and thus assumes there is an openapi.json in the current workspace.
82+
- name: Generate Angular Client
83+
uses: openapi-generators/openapitools-generator-action@v1
84+
with:
85+
generator: typescript-angular
86+
config-file: angular-generator-config.yml
87+
template-dir: templates/typescript-angular
88+
89+
# Do something with the generated client (likely publishing it somewhere)
90+
- name: Do something with the client
91+
run: |
92+
cd typescript-angular-client
93+
```

‎action.yml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ inputs:
2424
description: The path to the config file to be passed along to the OpenAPITools generator
2525
required: false
2626
default: UNSET
27+
template-dir:
28+
description: The path to the folder containing the template files
29+
required: false
30+
default: UNSET
2731
command-args:
2832
description: Optional, additional arguments to pass through to the generator.
2933
required: false
@@ -32,4 +36,4 @@ runs:
3236
using: composite
3337
steps:
3438
- shell: bash
35-
run: python ${{ github.action_path }}/entrypoint.py ${{ inputs.generator }} ${{ inputs.generator-tag }} ${{ inputs.openapi-file }} ${{ inputs.openapi-url }} ${{ inputs.config-file }} ${{ inputs.command-args}}
39+
run: python ${{ github.action_path }}/entrypoint.py ${{ inputs.generator }} ${{ inputs.generator-tag }} ${{ inputs.openapi-file }} ${{ inputs.openapi-url }} ${{ inputs.config-file }} ${{ inputs.template-dir }} ${{ inputs.command-args}}

‎entrypoint.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
from sys import argv
33
from os import getenv
44

5-
(_, generator, generator_tag, openapi_file, openapi_url, config_file, *args) = argv
5+
(_, generator, generator_tag, openapi_file, openapi_url, config_file, template_dir, *args) = argv
66

77
cmd = f"docker run -u 1001 --rm --workdir /github/workspace -v {getenv('GITHUB_WORKSPACE')}:/github/workspace"
88
cmd = f"{cmd} openapitools/openapi-generator-cli:{generator_tag} generate"
@@ -16,6 +16,9 @@
1616
if config_file != "UNSET":
1717
cmd = f"{cmd} -c /github/workspace/{config_file}"
1818

19+
if template_dir != "UNSET":
20+
cmd = f"{cmd} -t /github/workspace/{template_dir}"
21+
1922
if args:
2023
cmd = f"{cmd} {' '.join(args)}"
2124

‎test_data/templates/LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)
190+
Copyright 2018 SmartBear Software
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
https://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎test_data/templates/rust/.travis.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
language: rust

‎test_data/templates/rust/Cargo.mustache‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
[package]
2+
name = "{{{packageName}}}"
3+
version = "{{{packageVersion}}}"
4+
authors = ["OpenAPI Generator team and contributors"]
5+
edition = "2018"
6+
7+
[dependencies]
8+
serde = "^1.0"
9+
serde_derive = "^1.0"
10+
serde_json = "^1.0"
11+
url = "^2.2"
12+
{{#hyper}}
13+
hyper = { version = "~0.14", features = ["full"] }
14+
hyper-tls = "~0.5"
15+
http = "~0.2"
16+
serde_yaml = "0.7"
17+
base64 = "~0.7.0"
18+
futures = "^0.3"
19+
{{/hyper}}
20+
{{#reqwest}}
21+
{{^supportAsync}}
22+
reqwest = "~0.9"
23+
{{/supportAsync}}
24+
{{#supportAsync}}
25+
[dependencies.reqwest]
26+
version = "^0.11"
27+
features = ["json", "multipart"]
28+
{{/supportAsync}}
29+
{{/reqwest}}
30+
31+
[dev-dependencies]
32+
{{#hyper}}
33+
tokio-core = "*"
34+
{{/hyper}}

‎test_data/templates/rust/README.mustache‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Rust API client for {{{packageName}}}
2+
3+
{{#appDescriptionWithNewLines}}
4+
{{{.}}}
5+
{{/appDescriptionWithNewLines}}
6+
7+
{{#infoUrl}}
8+
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
9+
{{/infoUrl}}
10+
11+
## Overview
12+
13+
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
14+
15+
- API version: {{{appVersion}}}
16+
- Package version: {{{packageVersion}}}
17+
{{^hideGenerationTimestamp}}
18+
- Build date: {{{generatedDate}}}
19+
{{/hideGenerationTimestamp}}
20+
- Build package: `{{{generatorClass}}}`
21+
22+
## Installation
23+
24+
Put the package under your project folder in a directory named `{{packageName}}` and add the following to `Cargo.toml` under `[dependencies]`:
25+
26+
```
27+
{{{packageName}}} = { path = "./{{{packageName}}}" }
28+
```
29+
30+
## Documentation for API Endpoints
31+
32+
All URIs are relative to *{{{basePath}}}*
33+
34+
Class | Method | HTTP request | Description
35+
------------ | ------------- | ------------- | -------------
36+
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{{classname}}}* | [**{{{operationId}}}**]({{{apiDocPath}}}{{classname}}.md#{{{operationIdLowerCase}}}) | **{{{httpMethod}}}** {{{path}}} | {{{summary}}}
37+
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
38+
39+
## Documentation For Models
40+
41+
{{#models}}{{#model}} - [{{{classname}}}]({{{modelDocPath}}}{{{classname}}}.md)
42+
{{/model}}{{/models}}
43+
44+
To get access to the crate's generated documentation, use:
45+
46+
```
47+
cargo doc --open
48+
```
49+
50+
## Author
51+
52+
{{#apiInfo}}{{#apis}}{{#-last}}{{{infoEmail}}}
53+
{{/-last}}{{/apis}}{{/apiInfo}}

0 commit comments

Comments
 (0)