Comments (8)
You're lucky I'm bored right now. AutoSwagger.json()
is now implemented in version 2.14.x 😅 See the docs.
from adonis-autoswagger.
Currently, not. What would be the use case?
from adonis-autoswagger.
To parse data, to filter it depending on some conditions
from adonis-autoswagger.
docs()
returns a stringified YAML. You should be able convert it back into json.
from adonis-autoswagger.
Yes, i could use a package for this, but don't you convert js to yaml in this package? It Can be interesting to add in the options the output format wanted eventually.
from adonis-autoswagger.
Yes, I do convert it, and it additionally saves a swagger.yaml file, which is used in production mode.
When you run the adonisJS app in dev mode, everything works seamlessly. However, when you deploy it to production, you MUST execute node ace docs:generate
command, to generate the swagger.yml file, since in production you obviously don't have all the necessary references to the *.ts files and their comments, etc.
In this case, Autoswagger would have to create two file, swagger.yaml and swagger.json, to make it production ready.
from adonis-autoswagger.
Ok thx for the explanations. I think it could be a good option to have the choose of the output format. Autoswagger would have to create only one file depending of options defined in config/swagger.ts
from adonis-autoswagger.
Thx!
from adonis-autoswagger.
Related Issues (20)
- Scalar API Client Proxy Error HOT 5
- Feature Request: Add configure script HOT 2
- appPath: Not correct on controllers HOT 3
- Feature request: manual tag HOT 1
- Feature request: make requestFormDataBody support requestBody types HOT 9
- Token header with other type not Bearer HOT 4
- Production bug: trying to load different file HOT 1
- /swagger-yaml throws internal server error when running with build files HOT 4
- Question: How to Omit controller methods from the docs which doesn't exists HOT 1
- Documentation description? HOT 1
- Nested or extend interface not working with @responseBody HOT 16
- Annotations not Recognized in Controller HOT 3
- Feature request: Only routes HOT 1
- Feature Request: multiple tags with @tags HOT 1
- Bug Report - empty swagger sections after usage of @tag HOT 5
- Maximum call stack size exceeded HOT 2
- serializeAs: null not auto-detected HOT 1
- responseBody Issue HOT 19
- required field in schema HOT 2
- define params type HOT 1
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 adonis-autoswagger.