https://github.com/xivapi/angular-client
xivapi client library (service and models) for angular applications
https://github.com/xivapi/angular-client
xivapi
Last synced: 5 months ago
JSON representation
xivapi client library (service and models) for angular applications
- Host: GitHub
- URL: https://github.com/xivapi/angular-client
- Owner: xivapi
- License: mit
- Created: 2018-08-02T13:28:11.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T06:04:18.000Z (almost 3 years ago)
- Last Synced: 2025-11-23T18:21:46.251Z (7 months ago)
- Topics: xivapi
- Language: TypeScript
- Size: 3.02 MB
- Stars: 4
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# angular-client
[](https://circleci.com/gh/xivapi/angular-client/tree/master)
[](https://www.npmjs.com/package/@xivapi/angular-client)
## Documentation
Visit https://xivapi.com/docs for documentation about the web api mapped by this client.
Further documentation for this library available on documentation website: https://xivapi.github.io/angular-client/
## Installation
Simply run `npm i --save @xivapi/angular-client`
## Quick start
Add `XivapiClientModule` to your `AppModule` imports:
```ts
@NgModule({
declarations: [
AppComponent,
],
imports: [
...
XivapiClientModule.forRoot(),
...
],
bootstrap: [AppComponent]
})
export class AppModule {
}
```
In the other modules, don't call `forRoot` again, just import the module itself.
Then you can simply inject the service wherever you want to use it:
```ts
@Component({
...
})
export class FooComponent {
public items$: Observable>;
constructor(private xivapi: XivapiService){
this.items$ = this.xivapi.getList(XivapiEndpoint.Items);
}
}
```
## Use with private_key (Google Cloud Function)
- Create a google cloud function, name it as you want.
- Insert following code (with your key):
```js
exports.xivapiProxy = (req, res) => {
let request = require('request');
const apiKey = '>';
res.set('Access-Control-Allow-Origin', '')
.set('Access-Control-Allow-Headers', 'Content-Type');
const url = Buffer.from(req.query.url, 'base64').toString();
request(
{
url:`${url}${url.indexOf('?') > -1 ? '&':'?'}private_key=${apiKey}`,
},
function(error, response, body) {
let errorBody = JSON.parse(body);
let errorMessage = errorBody.error || errorBody.message;
if (error || errorMessage) {
res.status(400).send(errorMessage || 'Unknown Error');
} else {
res.status(200).set('Content-Type', 'application/json').send(body);
}
});
};
```
- Enable proxy mode inside the api module:
```ts
XivapiClientModule.forRoot('')
```
Example url: https://us-central1-myproject.cloudfunctions.net/xivapi-proxy
Keep in mind that you can enable it based on the current environment, simply give `null` as proxy url if environment isn't prod,
to use "normal" mode in order to get better debugging
when using dev environment.