Comments (3)
Interesting, so I am not sure that I understand the concern about them being global. All the .component
api does is add a spec compliant component section to the doc, so it is "global" in the sense that any other part of the doc can reference it ($ref
), but that is just how the spec works.
The api we expose is just a shorthand/helper so you dont have to write out the rather unpleasant format. So when you "use" the component you defined it just returns the ref: https://github.com/wesleytodd/express-openapi/blob/main/index.js#L94
Am I missing something about what you are asking? If so, please help me better understand.
from express-openapi.
I have a similar issue. I'm generating TypeScript types from JSON Schema files with https://github.com/bcherny/json-schema-to-typescript tool.
I want to use those JSON Schemas to generate OpenAPI docs like this
import MySchema from 'schemas/MySchema.json';
openapi.component('schemas', 'MySchema', MySchema);
And in MySchema.json
I have something like this
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"SubSchema": {
"type": "object",
"properties": {
"someValue": {
"type": "string"
}
}
}
},
"title": "MySchema",
"type": "object",
"properties": {
"someArray": {
"type": "array",
"items": { "$ref": "#/definitions/SubSchema" }
}
}
}
But this does not work with express-openapi. Only way I got it working was to move SubSchema to its own json file and change $ref
to { "$ref": "#/components/schemas/SubSchema" }
. Then change code to
import MySchema from 'schemas/MySchema.json';
import SubSchema from 'schemas/SubSchema.json';
openapi.component('schemas', 'SubSchema', SubSchema);
openapi.component('schemas', 'MySchema', MySchema);
After that TypeScript types generation fails because it can't find SubSchema anymore. Would it be possible to add support for definitions
and references inside same JSON Schema file?
from express-openapi.
Hey @nruotsal, I think this is a different request. I do not see a clear way to know what to merge from a call to .component
with the parent doc. Additionally, I think that you can achieve what you want with two calls into this package, so am not sure we would want to change the api to accommodate this particular case unless you can elaborate on the goal. If you think there is a strong argument for this, can you open a new issue and make the case for supporting this?
from express-openapi.
Related Issues (20)
- Obtaining openapi.yaml instead of openapi.json HOT 4
- Get generated OpenAPI document HOT 3
- Change openapi.json base URL HOT 1
- Lots of Content Security Policy errors HOT 5
- Bug with dynamic route and nested routers HOT 9
- Use TypeScript request handler definition to generate route description HOT 1
- Support default values in query params HOT 1
- Is this production ready? HOT 3
- Add typescript definition HOT 2
- bug with parameters; always string HOT 1
- Is this project still alive? HOT 2
- library is not picking up the paths in my express application HOT 6
- Hosting a service not at root causes incorrect path generation HOT 6
- npm update/install fails because of redoc old version HOT 8
- Webpack fail HOT 4
- Release 1.0.0 HOT 5
- split(...).join is not a function error with Express v5 HOT 4
- Use With Express Router HOT 3
- Using with router in node submodules doesn't show up in json HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from express-openapi.