-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[skyapi-angular] refs #9 Added generate rest api in angularv2
- Loading branch information
Maykel Arias Torres
committed
Aug 8, 2019
1 parent
95c30f1
commit 03b3b9c
Showing
57 changed files
with
4,978 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
wwwroot/*.js | ||
node_modules | ||
typings | ||
dist |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# OpenAPI Generator Ignore | ||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator | ||
|
||
# Use this file to prevent files from being overwritten by the generator. | ||
# The patterns follow closely to .gitignore or .dockerignore. | ||
|
||
# As an example, the C# client generator defines ApiClient.cs. | ||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: | ||
#ApiClient.cs | ||
|
||
# You can match any string of characters against a directory, file or extension with a single asterisk (*): | ||
#foo/*/qux | ||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux | ||
|
||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**): | ||
#foo/**/qux | ||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux | ||
|
||
# You can also negate patterns with an exclamation (!). | ||
# For example, you can ignore all files in a docs folder with the file extension .md: | ||
#docs/*.md | ||
# Then explicitly reverse the ignore rule for a single file: | ||
#!docs/README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
4.0.3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,176 @@ | ||
## @simelo/skyapi-angular@0.27.0 | ||
|
||
### Building | ||
|
||
To install the required dependencies and to build the typescript sources run: | ||
``` | ||
npm install | ||
npm run build | ||
``` | ||
|
||
### publishing | ||
|
||
First build the package then run ```npm publish``` | ||
|
||
### consuming | ||
|
||
Navigate to the folder of your consuming project and run one of next commands. | ||
|
||
_published:_ | ||
|
||
``` | ||
npm install @simelo/[email protected] --save | ||
``` | ||
|
||
_without publishing (not recommended):_ | ||
|
||
``` | ||
npm install PATH_TO_GENERATED_PACKAGE/@simelo/skyapi-angular-0.27.0.tgz --save | ||
``` | ||
|
||
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_ | ||
|
||
_using `npm link`:_ | ||
|
||
In PATH_TO_GENERATED_PACKAGE: | ||
``` | ||
npm link | ||
``` | ||
|
||
In your project: | ||
``` | ||
npm link @simelo/skyapi-angular | ||
``` | ||
|
||
__Note for Windows users:__ The Angular CLI has troubles to use linked npm packages. | ||
Please refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround. | ||
Published packages are not effected by this issue. | ||
|
||
|
||
#### General usage | ||
|
||
In your Angular project: | ||
|
||
|
||
``` | ||
// without configuring providers | ||
import { ApiModule } from '@simelo/skyapi-angular'; | ||
import { HttpModule } from '@angular/http'; | ||
@NgModule({ | ||
imports: [ | ||
ApiModule, | ||
HttpModule | ||
], | ||
declarations: [ AppComponent ], | ||
providers: [], | ||
bootstrap: [ AppComponent ] | ||
}) | ||
export class AppModule {} | ||
``` | ||
|
||
``` | ||
// configuring providers | ||
import { ApiModule, Configuration, ConfigurationParameters } from '@simelo/skyapi-angular'; | ||
export function apiConfigFactory (): Configuration => { | ||
const params: ConfigurationParameters = { | ||
// set configuration parameters here. | ||
} | ||
return new Configuration(params); | ||
} | ||
@NgModule({ | ||
imports: [ ApiModule.forRoot(apiConfigFactory) ], | ||
declarations: [ AppComponent ], | ||
providers: [], | ||
bootstrap: [ AppComponent ] | ||
}) | ||
export class AppModule {} | ||
``` | ||
|
||
``` | ||
import { DefaultApi } from '@simelo/skyapi-angular'; | ||
export class AppComponent { | ||
constructor(private apiGateway: DefaultApi) { } | ||
} | ||
``` | ||
|
||
Note: The ApiModule is restricted to being instantiated once app wide. | ||
This is to ensure that all services are treated as singletons. | ||
|
||
#### Using multiple OpenAPI files / APIs / ApiModules | ||
In order to use multiple `ApiModules` generated from different OpenAPI files, | ||
you can create an alias name when importing the modules | ||
in order to avoid naming conflicts: | ||
``` | ||
import { ApiModule } from 'my-api-path'; | ||
import { ApiModule as OtherApiModule } from 'my-other-api-path'; | ||
import { HttpModule } from '@angular/http'; | ||
@NgModule({ | ||
imports: [ | ||
ApiModule, | ||
OtherApiModule, | ||
HttpModule | ||
] | ||
}) | ||
export class AppModule { | ||
} | ||
``` | ||
|
||
|
||
### Set service base path | ||
If different than the generated base path, during app bootstrap, you can provide the base path to your service. | ||
|
||
``` | ||
import { BASE_PATH } from '@simelo/skyapi-angular'; | ||
bootstrap(AppComponent, [ | ||
{ provide: BASE_PATH, useValue: 'https://your-web-service.com' }, | ||
]); | ||
``` | ||
or | ||
|
||
``` | ||
import { BASE_PATH } from '@simelo/skyapi-angular'; | ||
@NgModule({ | ||
imports: [], | ||
declarations: [ AppComponent ], | ||
providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ], | ||
bootstrap: [ AppComponent ] | ||
}) | ||
export class AppModule {} | ||
``` | ||
|
||
|
||
#### Using @angular/cli | ||
First extend your `src/environments/*.ts` files by adding the corresponding base path: | ||
|
||
``` | ||
export const environment = { | ||
production: false, | ||
API_BASE_PATH: 'http://127.0.0.1:8080' | ||
}; | ||
``` | ||
|
||
In the src/app/app.module.ts: | ||
``` | ||
import { BASE_PATH } from '@simelo/skyapi-angular'; | ||
import { environment } from '../environments/environment'; | ||
@NgModule({ | ||
declarations: [ | ||
AppComponent | ||
], | ||
imports: [ ], | ||
providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }], | ||
bootstrap: [ AppComponent ] | ||
}) | ||
export class AppModule { } | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
import { NgModule, ModuleWithProviders, SkipSelf, Optional } from '@angular/core'; | ||
import { Configuration } from './configuration'; | ||
|
||
import { Http } from '@angular/http'; | ||
|
||
import { DefaultService } from './api/default.service'; | ||
|
||
@NgModule({ | ||
imports: [], | ||
declarations: [], | ||
exports: [], | ||
providers: [ | ||
DefaultService ] | ||
}) | ||
export class ApiModule { | ||
public static forRoot(configurationFactory: () => Configuration): ModuleWithProviders { | ||
return { | ||
ngModule: ApiModule, | ||
providers: [ { provide: Configuration, useFactory: configurationFactory } ] | ||
}; | ||
} | ||
|
||
constructor( @Optional() @SkipSelf() parentModule: ApiModule, | ||
@Optional() http: Http) { | ||
if (parentModule) { | ||
throw new Error('ApiModule is already loaded. Import in your base AppModule only.'); | ||
} | ||
if (!http) { | ||
throw new Error('You need to import the HttpModule in your AppModule! \n' + | ||
'See also https://github.com/angular/angular/issues/20575'); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
export * from './default.service'; | ||
import { DefaultService } from './default.service'; | ||
export const APIS = [DefaultService]; |
Oops, something went wrong.