# |
Jul 5th 2018, 16:28 |
bravo-kernel |
why and how it does JSON API is totally beyond me to be honest. I knew it was good but that good, haha |
# |
Jul 5th 2018, 16:27 |
bravo-kernel |
but I never got to that point |
# |
Jul 5th 2018, 16:27 |
bravo-kernel |
and... that should not be neccessary either, it can be done automatically |
# |
Jul 5th 2018, 16:27 |
james.phillips |
u r clever |
# |
Jul 5th 2018, 16:27 |
bravo-kernel |
I know, i made the plugin |
# |
Jul 5th 2018, 16:27 |
james.phillips |
its not realy automatic cos i have to write all the swg comments |
# |
Jul 5th 2018, 16:27 |
bravo-kernel |
the fact that it does/generates JSON API based on the comments is a 100% surprise to me |
# |
Jul 5th 2018, 16:26 |
james.phillips |
in my brain the api is working and I just put swg comments in the right places and the swagger ui tells me lovely things about my models and GET< POST based on the my sqg comments |
# |
Jul 5th 2018, 16:25 |
bravo-kernel |
:dancer: |
# |
Jul 5th 2018, 16:25 |
bravo-kernel |
do explain, my brain hasn't plopped yet |
# |
Jul 5th 2018, 16:25 |
josbeir |
serious as cancer bro |
# |
Jul 5th 2018, 16:24 |
bravo-kernel |
snap for real? |
# |
Jul 5th 2018, 16:24 |
james.phillips |
lol im confused. |
# |
Jul 5th 2018, 16:24 |
josbeir |
:) |
# |
Jul 5th 2018, 16:24 |
josbeir |
ooooo snap |
# |
Jul 5th 2018, 16:24 |
bravo-kernel |
that's totally unexpected to me but... looks prety cool |
# |
Jul 5th 2018, 16:23 |
james.phillips |
thats an example response |
# |
Jul 5th 2018, 16:23 |
slackebot4 |
"links": { "self": "/api/v1/crm-contacts/1" } }, { "type": "crm-contacts", "id": "2", "attributes": { "lastname": "Booker" }, "links": { "self": "/api/v1/crm-contacts/2" } } ] } |
# |
Jul 5th 2018, 16:23 |
james.phillips |
{ "meta": { "record_count": 111440, "page_count": 55720, "page_limit": null }, "links": { "self": "/api/v1/crm-contacts?page=1", "first": "/api/v1/crm-contacts?page=1", "last": "/api/v1/crm-contacts?page=55720", "prev": null, "next": "/api/v1/crm-contacts?page=2" }, "data": [ { "type": "crm-contacts", "id": "1", "attributes": { "lastname": "Caldock" }, |
# |
Jul 5th 2018, 16:23 |
james.phillips |
I have application/vnd.api+json in the reponse type dropdown |
# |
Jul 5th 2018, 16:22 |
bravo-kernel |
If I am wrong.... please do let me know, I still need auto-documenting for crud-json-api myself |
# |
Jul 5th 2018, 16:22 |
bravo-kernel |
and IMO that would make it unusable or at least not up to my standards as what I would like to present to my users |
# |
Jul 5th 2018, 16:21 |
bravo-kernel |
I am most sure it is not (yet/easily) possible to get the correct JSON API response there no matter the annotations |
# |
Jul 5th 2018, 16:21 |
bravo-kernel |
File uploaded https://cakesf.slack.com/files/U157AT2ET/FBKM6P8DB/image.png / https://slack-files.com/T053DPNCM-FBKM6P8DB-77841846e4 |
# |
Jul 5th 2018, 16:21 |
bravo-kernel |
before we move on... I checked the pet store just to make sure I am not tripping and what I mean is the following: |
# |
Jul 5th 2018, 16:20 |
josbeir |
https://github.com/alt3/cakephp-swagger/tree/master/webroot => https://github.com/swagger-api/swagger-ui dist stuff |
# |
Jul 5th 2018, 16:19 |
james.phillips |
in vendor alt cakephp-swagger? |
# |
Jul 5th 2018, 16:18 |
bravo-kernel |
replace the webroot files with current version and make sure the cake-additions are included |
# |
Jul 5th 2018, 16:18 |
james.phillips |
im dont mind being wrong just worried ive wasted time |
# |
Jul 5th 2018, 16:18 |
bravo-kernel |
updating is not too difficult |
# |
Jul 5th 2018, 16:18 |
bravo-kernel |
@james.phillips not saying you are wrong, just that I recall issues |
# |
Jul 5th 2018, 16:18 |
james.phillips |
im using the alt3 swagger...I will need to check if its too old |
# |
Jul 5th 2018, 16:17 |
james.phillips |
think im missing the point of what doesnt work....yes I have to put the swagger docs in my code but im fine with that. |
# |
Jul 5th 2018, 16:17 |
bravo-kernel |
the swagger-ui inside cakephp-swagger has not been updated for ages either so there is most likely a better/updated version out there |
# |
Jul 5th 2018, 16:15 |
bravo-kernel |
but hey, @james.phillips if you do have a fully working example please do share :dancer: |
# |
Jul 5th 2018, 16:15 |
bravo-kernel |
all other things are swagger-ui issues, sending the correct headers, authentication, hooking into the query params, etc, |
# |
Jul 5th 2018, 16:15 |
bravo-kernel |
:heavy_check_mark: |
# |
Jul 5th 2018, 16:14 |
josbeir |
me neither, years |
# |
Jul 5th 2018, 16:14 |
bravo-kernel |
relationships |
# |
Jul 5th 2018, 16:14 |
bravo-kernel |
I have not used it for ages but IIRC the schemas are/were the pain point |
# |
Jul 5th 2018, 16:14 |
josbeir |
indeed |