forked from loafle/openapi-generator-original
Merge branch 'update_typings_json' of https://github.com/leonyu/swagger-codegen into leonyu-update_typings_json
This commit is contained in:
commit
62db8e854b
@ -24,11 +24,10 @@ public class TypeScriptFetchClientCodegen extends AbstractTypeScriptClientCodege
|
|||||||
@Override
|
@Override
|
||||||
public void processOpts() {
|
public void processOpts() {
|
||||||
super.processOpts();
|
super.processOpts();
|
||||||
final String defaultFolder = apiPackage().replace('.', File.separatorChar);
|
supportingFiles.add(new SupportingFile("api.mustache", "", "api.ts"));
|
||||||
|
|
||||||
supportingFiles.add(new SupportingFile("api.mustache", null, "api.ts"));
|
|
||||||
supportingFiles.add(new SupportingFile("git_push.sh.mustache", "", "git_push.sh"));
|
supportingFiles.add(new SupportingFile("git_push.sh.mustache", "", "git_push.sh"));
|
||||||
supportingFiles.add(new SupportingFile("assign.ts", defaultFolder, "assign.ts"));
|
supportingFiles.add(new SupportingFile("assign.ts", "", "assign.ts"));
|
||||||
|
supportingFiles.add(new SupportingFile("README.md", "", "README.md"));
|
||||||
supportingFiles.add(new SupportingFile("package.json.mustache", "", "package.json"));
|
supportingFiles.add(new SupportingFile("package.json.mustache", "", "package.json"));
|
||||||
supportingFiles.add(new SupportingFile("typings.json.mustache", "", "typings.json"));
|
supportingFiles.add(new SupportingFile("typings.json.mustache", "", "typings.json"));
|
||||||
supportingFiles.add(new SupportingFile("tsconfig.json.mustache", "", "tsconfig.json"));
|
supportingFiles.add(new SupportingFile("tsconfig.json.mustache", "", "tsconfig.json"));
|
||||||
|
@ -0,0 +1,44 @@
|
|||||||
|
# TypeScript-Fetch
|
||||||
|
|
||||||
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The codegen Node module can be used in the following environments:
|
||||||
|
|
||||||
|
* Node.JS
|
||||||
|
* Webpack
|
||||||
|
* Browserify
|
||||||
|
|
||||||
|
It is usable in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `typings` in `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
|
||||||
|
|
||||||
|
### Installation ###
|
||||||
|
|
||||||
|
`swagger-codegen` does not generate JavaScript directly. The codegen Node module comes with `package.json` that bundles `typescript` and `typings` so it can self-compile. The self-compile is normally run automatically via the `npm` `postinstall` script of `npm install`.
|
||||||
|
|
||||||
|
CAVEAT: Due to [privilege implications](https://docs.npmjs.com/misc/scripts#user), `npm` may skip `postinstall` script if the user is `root`. You would need to manually invoke `npm install` or `npm run postinstall` for the codegen module if that's the case.
|
||||||
|
|
||||||
|
#### NPM repository ###
|
||||||
|
If you remove `"private": true` from `package.json`, you may publish the module to NPM. In which case, you would be able to install the module as any other NPM module.
|
||||||
|
|
||||||
|
It maybe useful to use [scoped packages](https://docs.npmjs.com/misc/scope).
|
||||||
|
|
||||||
|
#### NPM install local file ###
|
||||||
|
You should be able to directly install the module using `npm install file:///codegen_path`.
|
||||||
|
|
||||||
|
NOTES: If you do `npm install file:///codegen_path --save` NPM might convert your path to relative path, maybe have adverse affect. `npm install` and `npm shrinkwrap` may misbehave if the installation path is not absolute.
|
||||||
|
|
||||||
|
#### direct copy/symlink ###
|
||||||
|
You may also simply copy or symlink the codegen into a directly under your project. The syntax of the usage would differ if you take this route. (See below)
|
||||||
|
|
||||||
|
### Usage ###
|
||||||
|
With ES6 module syntax, the following syntaxes are supported:
|
||||||
|
```
|
||||||
|
import * as localName from 'npmName';
|
||||||
|
import {operationId} from 'npmName';
|
||||||
|
|
||||||
|
import * as localName from './symlinkDir';
|
||||||
|
import {operationId} from './symlinkDir';
|
||||||
|
```
|
||||||
|
With CommonJS, the following syntaxes are supported:
|
||||||
|
```
|
||||||
|
import localName = require('npmName');
|
||||||
|
|
||||||
|
import localName = require('./symlinkDir')';
|
||||||
|
```
|
@ -2,8 +2,9 @@
|
|||||||
"name": "{{#npmName}}{{{npmName}}}{{/npmName}}{{^npmName}}typescript-fetch-api{{/npmName}}",
|
"name": "{{#npmName}}{{{npmName}}}{{/npmName}}{{^npmName}}typescript-fetch-api{{/npmName}}",
|
||||||
"version": "{{#npmVersion}}{{{npmVersion}}}{{/npmVersion}}{{^npmVersion}}0.0.0{{/npmVersion}}",
|
"version": "{{#npmVersion}}{{{npmVersion}}}{{/npmVersion}}{{^npmVersion}}0.0.0{{/npmVersion}}",
|
||||||
"private": true,
|
"private": true,
|
||||||
"main": "dist/api.js",
|
"main": "./dist/api.js",
|
||||||
"browser": "dist/api.js",
|
"browser": "./dist/api.js",
|
||||||
|
"typings": "./dist/api.d.ts",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"isomorphic-fetch": "^2.2.1"
|
"isomorphic-fetch": "^2.2.1"
|
||||||
},
|
},
|
||||||
|
@ -1,11 +1,13 @@
|
|||||||
{
|
{
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
|
"declaration": true,
|
||||||
"target": "{{#supportsES6}}es6{{/supportsES6}}{{^supportsES6}}es5{{/supportsES6}}",
|
"target": "{{#supportsES6}}es6{{/supportsES6}}{{^supportsES6}}es5{{/supportsES6}}",
|
||||||
"module": "commonjs",
|
"module": "commonjs",
|
||||||
"noImplicitAny": true,
|
"noImplicitAny": true,
|
||||||
"outDir": "dist"
|
"outDir": "dist"
|
||||||
},
|
},
|
||||||
"exclude": [
|
"exclude": [
|
||||||
|
"dist",
|
||||||
"node_modules",
|
"node_modules",
|
||||||
"typings/browser",
|
"typings/browser",
|
||||||
"typings/main",
|
"typings/main",
|
||||||
|
@ -4,6 +4,6 @@
|
|||||||
"ambientDependencies": {
|
"ambientDependencies": {
|
||||||
{{^supportsES6}} "es6-promise": "registry:dt/es6-promise#0.0.0+20160423074304",
|
{{^supportsES6}} "es6-promise": "registry:dt/es6-promise#0.0.0+20160423074304",
|
||||||
{{/supportsES6}} "node": "registry:dt/node#4.0.0+20160423143914",
|
{{/supportsES6}} "node": "registry:dt/node#4.0.0+20160423143914",
|
||||||
"isomorphic-fetch": "github:leonyu/DefinitelyTyped/isomorphic-fetch/isomorphic-fetch.d.ts#isomorphic-fetch-fix-module"
|
"isomorphic-fetch": "registry:dt/isomorphic-fetch#0.0.0+20160505171433"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user