New API for APIs.io - Githubissues

picsoung commented 9 years ago

Here is the place for a discussion about what you want to see in the new APIs.io 's API.

The current documentation could be found here

What I had in mind to add:

pagination on results
a search endpoint, to search for apis the same way that on the site
clarify ping endpoint
add optional fields param to ask for particular fields
add offset,limit

Any other thoughts and stuff that you want to see in it?

apimatic commented 9 years ago

Hi. The search is not working for me. I tried the following.

http://staging.apis.io/api/apis/search?q=concur

picsoung commented 9 years ago

Search endpoint search in title, description or tags. For the concur API you have to search for "travel"

http://staging.apis.io/api/search?q=travel

picsoung commented 9 years ago

Added fields to filter per field, order that could desc or asc, sort that specify which field to sort by skip that should be rename offset ?

Also added previous and next for paging purpose

Example http://staging.apis.io/api/search?q=a&fields=name&limit=5&sort=name&order=desc

apimatic commented 9 years ago

We are all set to transition to new API when you guys are ready.

picsoung commented 9 years ago

We've moved to the new API :)

apimatic commented 9 years ago

For some reason, the behaviour of staging and release is different. I am not seeing any swagger definition in the data returned by the new API.

picsoung commented 9 years ago

Here is all the apis that have a swagger spec http://apis.io/api/search?q=&swagger=true

what do you get on your side?

apimatic commented 9 years ago

Yes, this worked. How about if I also want RAML, API BluePrint etc

picsoung commented 9 years ago

good suggestion. I will try to make it more generic so you could do {field}=true

apimatic commented 9 years ago

Can you go something like "machineReadable=true" This would cover any format that may be used by anyone such as Google Discovery and IODocs

gregturn commented 9 years ago

It would be neat to use a convention like application/hal+json where each document offers a consistent set of links.
It wouldn't hurt if all the links were fully navigable URIs. listAPI [GET]: "/api/apis" is a bit confusing. Is that the full path after the hostname? Or to be appended to the current path?
http://apis.io/api/ showed links, but when I navigated to http://apis.io/api/apis, I didn't see any links entries there. There doesn't seem to be any convention on where to look for links to related records.

picsoung commented 9 years ago

@gregturn Did we solve all the issues you mentioned ? http://apis.io/api ?

thanks

apisio / apis.io

New API for APIs.io #9