actidoo / pyramid_swagger_spec Goto Github PK

When using traversal:

• For the developer it would be best to just define the context and leave out the path definition.
• But: The swagger-definition needs a concrete URL

Can we derive possible URLs from our Ressources ? Probably not possible using the default-ressource requirements.

Suggestion 1:

• Create a base class / interface for the ressources
• Derive URLs from that

Suggestions 2:

• Keep the developer define the URLs (either in the decorator - or in the routes.py, reference using route_name)
• Add traversal option to the decorator which defines the traversal path
• Route/Traversal should be a list to support multiple locations

To support recursive schemas (i.e. a tree with arbitrary height), we need to be able to separate schema definitions and reference them ($ref).

How can we change the design of the API-definition decorator to make this as little annoying as possible for the developer while not applying too much magic?