Comments (7)
Thank for your reply.
In my opinion, the first scheme is simpler for users. As before, users do not need to consider configuring static files.
If you agree, I can submit pull requests or you can handle it yourself.
from spectree.
Thank you, I have stored static files into my project, and have implemented offline swagger and redoc (refer to your source code and add two routes)
from spectree.
Welcome PR.
I have some concerns about this one.
- The offline mode should be an opt-in feature. By default, we should use the CDN to get the latest version.
- I don't want to add lots of static files into the code and update them later. There are some other ways to pack them into the Python library. Maybe downloading static files in the packaging stage or use the post-installation hook.
from spectree.
I just checked the static files. It mainly contains two sources:
There are several solutions:
- store these files in this library as extra data
- need to update with this library
- pack these files into another library and use
pip install spectree[offline]
to install- can update separately
By the way, GitLab already supports rendering swagger UI with YAML/JSON file. So you can upload the generated openapi.json
file to the GitLab repo for offline usage.
from spectree.
Hi,
I was looking for a way to serve the swagger/redoc static files without relaying on CDNs. In my case my app runs in an environment in which the outgoing requests to CDNs can be blocked.
@luolingchun can you elaborate on how you solved this? @kemingy are you willing to accept a PR adding an optional configuration for an alternative source for static files?
Thanks
from spectree.
@ariciputi You can go to my GitHub homepage,find the flask-openapi3
project and read the source code。The idea is to use blueprint
manage the swagger/redoc static files。
from spectree.
@luolingchun thanks.
from spectree.
Related Issues (20)
- [BUG] Spectree flask plugin is logging request validation errors twice HOT 2
- [Question] Is it possible to specify a BaseModel class as a Redoc Model? HOT 1
- Potentially leaky tests HOT 1
- Falcon: before in validate decorator not working?
- [Question] Skip validation for real? HOT 8
- Key appended to Schema Component HOT 5
- Exclude routes from OpenAPI spec HOT 1
- Feature Request: Remove Duplicate Schema Components HOT 3
- feat: support `msgspec` as another schema definition
- feat: Disable publishing of /apidoc route HOT 1
- bug: annotations NameError issue caused by python bug HOT 1
- bug: spectree doesn't support pydantic 2.x but doesn't restrict in pyproject.toml HOT 1
- bug: don't support pydantic v2 HOT 5
- feat: add an abstract layer to support pydantic[v1]/pydantic[v2]/msgspec
- bug: Flask Response Validation Error Results in Exception, Unintended 500 content HOT 1
- bug: An empty request is not validated / the content type is not enforced HOT 1
- bug: SecuritySchemeData root_validator conflicts with alias HOT 2
- bug: field alias no longer respected (regression) HOT 6
- bug: List[int] in query params does not accept a list of size 1 in flask app HOT 2
- bug: resp_validation_error is not passed in after handler of flask plugin
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 spectree.