Package Exports
- @sparing-software/sparing-open-api
- @sparing-software/sparing-open-api/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sparing-software/sparing-open-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Installation
npm i @sparing-software/sparing-open-apiUsage
Set environmental variables
OPEN_API_URL(required) - http address of JSON OpenAPI schema to your APIOPEN_API_OUT_DIR(default:./service) - output directory for generated http serviceOPEN_API_OUT_FILENAME(default:__generated-api.ts) - output filename (filename must be with .ts extension)
In order to help webpack automatically map aliases for generated file in Vue/React projects please use the following config:
OPEN_API_OUT_DIR=./src/serviceTo comfortly use generated service in futher application consider creating another file in service folder:
service/http.service.ts
import { Api } from './$OPEN_API_OUT_FILENAME'
export const httpService = new Api({
baseURL: process.env.VUE_APP_API_URL
})
httpService.instance.interceptors.request.use(config => {
config.headers.Authorization = localStorage.getItem('token')
return config
})Which can be later easily used as follows:
import { httpService } from '@/service/http.service'
const issues = await httpService.projects.getIssues(project.id)It is also recommended to add prebuild and preserve/predev scripts to your package.json file in order to get the newest api on each start:
{
"scripts": {
"prebuild": "sparing-open-api",
"preserve": "sparing-open-api",
...
}
}Or you can always do it manually by running sparing-open-api from terminal opened inside your project.
Contributing
Want to help improve this plugin? Great!
Project is open-source so fork repo and join us!
License
MIT License © Sparing Interactive