[TypeScript] add new generator for Axios #892

nicokoenig · 2018-08-24T07:11:28Z

PR checklist

Read the contribution guidelines.
Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
Filed the PR against the correct branch: master, 3.3.x, 4.0.x. Default: master.
Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

(details of the change, additional tests that have been done, reference to the issue for tracking, etc)

nicokoenig · 2018-08-24T07:11:49Z

wing328 · 2018-08-24T07:28:27Z

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

wing328 · 2018-08-24T12:33:57Z

cc the technical committee for review

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01)

macjohnny

I can't find differences to the typescript-fetch generator. What is the new feature of this generator?

macjohnny · 2018-08-24T12:45:25Z

modules/openapi-generator/src/main/resources/typescript-axios/README.mustache

@@ -0,0 +1,45 @@
+## {{npmName}}@{{npmVersion}}
+
+This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:


is this correct? shouldn't it be about axios?

macjohnny · 2018-08-24T12:48:59Z

modules/openapi-generator/src/main/resources/typescript-axios/api.mustache

@@ -0,0 +1,368 @@
+/// <reference path="./custom.d.ts" />


I can't find differences to https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/typescript-fetch/api.mustache

I believe @nicokoenig has made some updates to use axios.

@nicokoenig have you committed those changes to this PR?

Not yet, changes to come. I made the PR on behalf of @wing328 so that he could check for initial mistakes 👍

nicokoenig · 2018-08-28T06:41:13Z

I pushed some updates... could someone please have a look? ☺️

wing328 · 2018-08-28T14:28:00Z

modules/openapi-generator/src/main/resources/typescript-axios/package.mustache

+    "build": "tsc --outDir dist/",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {


Do we need to add axios dependency (peer, dev) somehow?

e.g. https://github.com/sheaivey/react-axios/blob/master/package.json#L45, https://github.com/sheaivey/react-axios/blob/master/package.json#L50

Disclaimer: I'm no expert in TS/JS

You are right, sorry I missed that.

Commit is already pushed.

wing328 · 2018-08-28T14:28:21Z

modules/openapi-generator/src/main/resources/typescript-axios/package.mustache

+  "description": "OpenAPI client for {{npmName}}",
+  "author": "OpenAPI-Generator Contributors",
+  "keywords": [
+    "fetch",


Minor suggestion: replace "fetch" with "axios"?

nicokoenig · 2018-08-31T06:35:42Z

@wing328 Any updates here? 😺

macjohnny

please generate some samples, otherwise it is hard to understand the output.
e.g. like https://github.com/OpenAPITools/openapi-generator/blob/master/bin/typescript-angular-v6-petstore-provided-in-root.sh

wing328 · 2018-09-02T08:32:34Z

@nicokoenig to elaborate on @macjohnny feedback a little bit, here are the scripts/batch files for TypeScript Fetch:

➜  openapi-generator git:(master) ✗ ls -l ./bin/typescript-fetch*
-rwxr-xr-x  1 williamcheng  staff  190 Aug  3 14:12 ./bin/typescript-fetch-petstore-all.sh
-rwxr-xr-x  1 williamcheng  staff  904 Aug  3 14:12 ./bin/typescript-fetch-petstore-interfaces.sh
-rw-r--r--  1 williamcheng  staff  181 Aug  3 14:12 ./bin/typescript-fetch-petstore-target-es6.json
-rwxr-xr-x  1 williamcheng  staff  925 Aug  3 14:12 ./bin/typescript-fetch-petstore-target-es6.sh
-rw-r--r--  1 williamcheng  staff  158 Aug  3 14:12 ./bin/typescript-fetch-petstore-with-npm-version.json
-rwxr-xr-x  1 williamcheng  staff  937 Aug  3 14:12 ./bin/typescript-fetch-petstore-with-npm-version.sh
-rwxr-xr-x  1 williamcheng  staff  873 Aug  3 14:12 ./bin/typescript-fetch-petstore.sh

Windows batch file:

➜  openapi-generator git:(master) ✗ ls -l ./bin/windows/typescript-fetch*
-rw-r--r--  1 williamcheng  staff  238 Aug  3 14:12 ./bin/windows/typescript-fetch-petstore-all.bat
-rw-r--r--  1 williamcheng  staff  430 Aug  3 14:12 ./bin/windows/typescript-fetch-petstore-interfaces.bat
-rw-r--r--  1 williamcheng  staff  439 Aug  3 14:12 ./bin/windows/typescript-fetch-petstore-target-es6.bat
-rw-r--r--  1 williamcheng  staff  451 Aug  3 14:12 ./bin/windows/typescript-fetch-petstore-with-npm-version.bat
-rw-r--r--  1 williamcheng  staff  394 Aug  3 14:12 ./bin/windows/typescript-fetch-petstore.bat

Please create something similar to generate the Petstore sample and you can copy the tests from TS Fetch Petstore.

If you need any help, please let me know.

macjohnny · 2018-09-03T12:45:14Z

it might also be worth adding some integration test to ensure the generated code does not break in the future.
See e.g. https://github.com/OpenAPITools/openapi-generator/tree/master/samples/client/petstore/typescript-fetch/tests/default and https://github.com/OpenAPITools/openapi-generator/blob/master/pom.xml#L1027

cyberwitch · 2018-09-12T23:27:43Z

modules/openapi-generator/src/main/resources/typescript-axios/api.mustache

+    {{/hasFormParams}}
+    {{#bodyParam}}
+            const needsSerialization = (<any>"{{dataType}}" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body =  needsSerialization ? JSON.stringify({{paramName}} || {}) : ({{paramName}} || "");


This needs to go in localVarRequestOptions.data - there is no body option in Axios.

Thanks for the hint.

wing328 · 2018-09-13T13:36:50Z

@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny please have another look as @nicokoenig has added test cases (petstore integration tests) and updated Travis CI config to run these tests as part of the build.

wing328 · 2018-09-16T08:11:44Z

If no further feedback, I'll merge this PR into master on Monday so that we can start collecting feedback from TypeScript developers.

wing328 · 2018-09-18T06:38:57Z

Tweet to promote the new generator: https://twitter.com/oas_generator/status/1041939441109983232

* feature: add generator for typescript/axios * feature: add sample scripts and sample code * fix: set request body in data property * feature: add samples and tests for typescript axios client * test: add tests for typescript axios client

wing328 added Client: TypeScript Enhancement: New generator labels Aug 24, 2018

macjohnny reviewed Aug 24, 2018

View reviewed changes

wing328 added the WIP Work in Progress label Aug 25, 2018

wing328 reviewed Aug 28, 2018

View reviewed changes

feature: add generator for typescript/axios

ecf2f60

nicokoenig force-pushed the feature/typescript-axios-generator branch from 2ff3c41 to ecf2f60 Compare August 29, 2018 07:55

macjohnny reviewed Aug 31, 2018

View reviewed changes

feature: add sample scripts and sample code

0dc8364

cyberwitch reviewed Sep 12, 2018

View reviewed changes

nicokoenig added 3 commits September 13, 2018 08:24

fix: set request body in data property

c7c45fa

feature: add samples and tests for typescript axios client

ca2dad0

test: add tests for typescript axios client

0e08315

nicokoenig force-pushed the feature/typescript-axios-generator branch from ca156fb to 0e08315 Compare September 13, 2018 10:14

wing328 added this to the 3.3.0 milestone Sep 13, 2018

wing328 removed the WIP Work in Progress label Sep 13, 2018

wing328 merged commit 3027514 into OpenAPITools:master Sep 18, 2018

wing328 changed the title ~~feature: add scaffold for typescript axios template~~ [TypeScript] add new generator for Axios Sep 18, 2018

klippx mentioned this pull request Mar 20, 2024

[idea] support openapi/swagger tulios/mappersmith#454

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TypeScript] add new generator for Axios #892

[TypeScript] add new generator for Axios #892

nicokoenig commented Aug 24, 2018 •

edited

Loading

nicokoenig commented Aug 24, 2018

wing328 commented Aug 24, 2018

wing328 commented Aug 24, 2018

macjohnny left a comment

macjohnny Aug 24, 2018

macjohnny Aug 24, 2018

wing328 Aug 24, 2018

nicokoenig Aug 24, 2018

nicokoenig commented Aug 28, 2018

wing328 Aug 28, 2018

nicokoenig Aug 29, 2018

wing328 Aug 28, 2018

nicokoenig commented Aug 31, 2018

macjohnny left a comment

wing328 commented Sep 2, 2018

macjohnny commented Sep 3, 2018

cyberwitch Sep 12, 2018

nicokoenig Sep 13, 2018

wing328 commented Sep 13, 2018

wing328 commented Sep 16, 2018

wing328 commented Sep 18, 2018

		@@ -0,0 +1,45 @@
		## {{npmName}}@{{npmVersion}}

		This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:

[TypeScript] add new generator for Axios #892

[TypeScript] add new generator for Axios #892

Conversation

nicokoenig commented Aug 24, 2018 • edited Loading

PR checklist

Description of the PR

nicokoenig commented Aug 24, 2018

wing328 commented Aug 24, 2018

wing328 commented Aug 24, 2018

macjohnny left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicokoenig commented Aug 28, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicokoenig commented Aug 31, 2018

macjohnny left a comment

Choose a reason for hiding this comment

wing328 commented Sep 2, 2018

macjohnny commented Sep 3, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wing328 commented Sep 13, 2018

wing328 commented Sep 16, 2018

wing328 commented Sep 18, 2018

nicokoenig commented Aug 24, 2018 •

edited

Loading