search

fahrgemeinschaft / r2gApi

Ride2Go API for Ridesharing
GNU Lesser General Public License v3.0
1 stars 1 forks source link

Improving API documentation #6

Open yncyrydybyl opened 4 years ago

yncyrydybyl commented 4 years ago

The documentation at /v3/api-docs should be improved in a meaningful way. Goal is to have a API - document that can be given away to partners and other developer.

It can be seen at -> https://r2g.api.dev.services.rd2g.de/swagger-ui/index.html?url=/v3/api-docs

yncyrydybyl commented 4 years ago

The persona search is wrong. There should be a way of searching for a persona but not in the same way like a trip. The php api supports something like:

curl 'https://service.live.ride2go.com/user?apikey=c740696c7008b3d8bf206a59535affeccd8e16687d4b33758b9e357ddbbfa871&suggest=yan&limit=10&offset=0&count=0' -H 'Connection: keep-alive' -H 'Accept: application/json, text/plain, */*' -H 'apikey: 311caa535fbbb7208d865109f5a1c6a2febbdf5e7a25a94ee53d442bb89cc2b54120fec6520cbb5c6bd07f1c7c9a2209218b26a4d7698be070fb04ee558b1c52' -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36' -H 'Origin: https://live.ride2go.com' -H 'Sec-Fetch-Site: same-site' -H 'Sec-Fetch-Mode: cors' -H 'Referer: https://live.ride2go.com/' -H 'Accept-Encoding: gzip, deflate, br' -H 'Accept-Language: de,hi;q=0.9,en;q=0.8' --compressed