This repository has been archived by the owner on Sep 16, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 15
Provide schema defintion based on ALPS spec #29
Comments
we have good experiences with swagger, which is relatively lightweight.
i did not find what ALPS would look like but it seems to be on a more
abstract level? if the two are similar, we can maybe generate both from
the same data.
i am not sure to what extent we can actually do this. afaik the main
challenge is to describe the data models. we could generate model
description from phpdoc + doctrine mappings. but a user might decide to
let some mapped properties be handled by doctrine listeners or something
rather than editable by the client.
|
Generating that stuff out of the doctrine metadata is a good idea, Would work for both. I really love swagger.io too, but do we have a chance to dynamically create documentations? Ah, yea that is the point swagger and RAML a kind of documentations, but ALPS is a little bit different, it describes the semantics what you can do on resources, and what you can do on its properties. You can find nice slides here. |
i am unsure how much we can automate semantic things. but if its
possible then FOSRestBundle or the HateoasBundle sound like the best
place for that. or maybe even a stand alone library/bundle if none
exists yet (though i don't intend to start yet another project).
for swagger, there is https://github.com/zircote/swagger-php which would
really profit from a symfony integration.
|
ElectricMaxxx
added a commit
that referenced
this issue
Nov 16, 2017
# This is the 1st commit message: DevKit updates # This is the commit message #2: improvements to get the tests running # This is the commit message #3: try to call unit tests only # This is the commit message #4: DevKit updates # This is the commit message #5: add correct cache/log path to gitignor # This is the commit message #6: DevKit updates # This is the commit message #7: DevKit updates # This is the commit message #8: DevKit updates # This is the commit message #9: DevKit updates # This is the commit message #10: DevKit updates # This is the commit message #11: DevKit updates # This is the commit message #12: restriction on sebastion/exporter # This is the commit message #13: fix composer.json # This is the commit message #14: use higher versions # This is the commit message #15: use higher version # This is the commit message #16: DevKit updates # This is the commit message #17: DevKit updates # This is the commit message #18: DevKit updates # This is the commit message #19: try verbose # This is the commit message #20: try testdox # This is the commit message #21: try makefile change # This is the commit message #22: try travis # This is the commit message #23: back # This is the commit message #24: restrict sebastianbergmann/environment # This is the commit message #25: restrict sebastianbergmann/environment # This is the commit message #26: try to turn around # This is the commit message #27: support symfony 3.4, new testing app folder structure # This is the commit message #28: support symfony 3.4, new testing app folder structure # This is the commit message #29: use caret operator for symfony-cmf/resource-bundle
ElectricMaxxx
added a commit
that referenced
this issue
Nov 16, 2017
* # This is a combination of 29 commits. # This is the 1st commit message: DevKit updates # This is the commit message #2: improvements to get the tests running # This is the commit message #3: try to call unit tests only # This is the commit message #4: DevKit updates # This is the commit message #5: add correct cache/log path to gitignor # This is the commit message #6: DevKit updates # This is the commit message #7: DevKit updates # This is the commit message #8: DevKit updates # This is the commit message #9: DevKit updates # This is the commit message #10: DevKit updates # This is the commit message #11: DevKit updates # This is the commit message #12: restriction on sebastion/exporter # This is the commit message #13: fix composer.json # This is the commit message #14: use higher versions # This is the commit message #15: use higher version # This is the commit message #16: DevKit updates # This is the commit message #17: DevKit updates # This is the commit message #18: DevKit updates # This is the commit message #19: try verbose # This is the commit message #20: try testdox # This is the commit message #21: try makefile change # This is the commit message #22: try travis # This is the commit message #23: back # This is the commit message #24: restrict sebastianbergmann/environment # This is the commit message #25: restrict sebastianbergmann/environment # This is the commit message #26: try to turn around # This is the commit message #27: support symfony 3.4, new testing app folder structure # This is the commit message #28: support symfony 3.4, new testing app folder structure # This is the commit message #29: use caret operator for symfony-cmf/resource-bundle * merge conflicts DevKit updates for master branch (#59) * DevKit updates * DevKit updates * merge conflicts fixes due to StyleCI fix symfony component version * re add packages after merging
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
To give customers of the api the right tool to get information abaout a resource we should provide profile information based on ALPS spec
The text was updated successfully, but these errors were encountered: