Comments (6)
Thanks @alexandreleroux. API HTML output is probably best realized by a Swagger UI. The problem is how to integrate this in the install. Any ideas @pvgenuchten / @justb4?
Another option is to have a configuration to point to an external Swagger UI like:
server:
swagger-ui: http://petstore.swagger.io/?url=
Which an API HTML handler would 301 to https://petstore.swagger.io/?url=https://geo.weather.gc.ca/geomet/features/api
from pygeoapi.
Isn't this functionality what is also provided by Flasgger and https://github.com/gangverk/flask-swagger ?
from pygeoapi.
@justb4 I think flasgger and Flask-swagger are bound to classes in Python? pygeoapi is not setup that way. We have an offline workflow which generates the OpenAPI Description. The value here is that we are able to scan each dataset configured in pygeoapi and report attributes as OpenAPI parameters.
from pygeoapi.
ok, I see, also came bit later into the API/Swagger//PyGeoAPI game. From what I learned an external Swagger UI is "the thing"? That was probably a reason that Flask-Swagger forked from Flassger, so different approach.
But ok, so we need an external Swagger-UI? Maybe a Swagger-UI instance on a PyGeoAPI server/domain as discussed? Or we could dynamically generate annotated Flask .py Views from the configured datasets but that may be far-fetched...
from pygeoapi.
There is no python library (or webservice) which generates an api-documentation-page from an openapi-specification-document? For me it makes most sense to have the interactive-api-documentation at api?f=html and not on some external location. But as a start a forward rule to https://petstore.swagger.io/?url=https://geo.weather.gc.ca/geomet/features/api would give a same experience.
from pygeoapi.
Implemented in #101.
from pygeoapi.
Related Issues (20)
- Enable CQL filtering to accept filter geometries in any CRS HOT 1
- most recent version of starlette breaks pygeoapi CI
- allow running pygeoapi starlette with uvloop
- Improve documentation about Tile Publishing HOT 1
- Address requirement 5 of OGC API - Tiles Core Requirements HOT 1
- Address requirement 6A of OGC API - Tiles Core Requirements for the MVT-elastic provider
- pygeoapi serve runs pygeoapi web application twice HOT 3
- Serving tiles from a url on mvt-tippecanoe is not working HOT 1
- Error starting pygeoapi with django server
- Provide a default configuration if none given
- replace geoalchemy with geoalchemy2 as a dependency
- wfs provider tests fail occasionally HOT 2
- Make sqlalchemy a first level dependency for providers
- Do not provide an option to choose charset for compressed GZIP responses
- mimetype config option does nothing HOT 2
- Remove server host and port from pygeoapi configuration
- Starlette get request data does not work after dropping dependency on nest-asyncio HOT 1
- Django EDR implementation broken on non-instance endpoints
- Retreiving feature count from WFS HOT 1
- Error while adding ESRI Feature service 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 pygeoapi.