Comments (1)
It is not that hard to create a script to do that. feathers-swagger
adds the generated specification as a property to the app object. (The name of the property could be adjusted with the appProperty
option)
To add the property to the typescript definitions you have to adjust the declarations.ts
:
// The application instance type that will be used everywhere else
export type Application = FeathersApplication<ServiceTypes, Configuration> & {
docs?: Record<string, unknown>;
};
Then you can create a script / entrypoint in the src directory, for example generate-swagger.ts
import fs from 'node:fs';
import path from 'node:path';
import { app } from './app';
import { logger } from './logger';
app.setup().then(() => {
fs.writeFileSync(path.join(__dirname, '..', 'swagger.json'), JSON.stringify(app.docs));
logger.info('Wrote swagger.json');
});
You can then run that script with: npx ts-node src/generate-swagger.ts
If you prefer yaml output, you can of course also add a yaml writer package and write the object as yaml.
from feathers-swagger.
Related Issues (20)
- Feature: Add support for multi create
- Feature: Add support for pagination
- Feature: Respect x-forwarded-prefix header
- Support for feathers v5 (Dove) HOT 9
- Error: Invalid service object passed for path `docs` HOT 3
- Feature: Support koa
- Feature: Support dove custom methods
- Feature: Create documentation for services with schemas of Feathersjs dove (v5)
- Documentation: Use docsify for documentation
- Bug: Can't access ID in path HOT 2
- Feature: Handle Type.Literal HOT 7
- Bug: Custom method definitions are effecting other methods HOT 1
- Feature: Documentation is only generated for methods provided via service options
- How can I get correct prefix with $ref in related models? HOT 2
- Bug: Documentation for Usage with SwaggerUI
- Feature: ESM module HOT 7
- How to stop autogeneration of swagger-json HOT 1
- Change or fill summary key on query HOT 6
- Swagger sequelize schema generation HOT 2
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 feathers-swagger.