Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New API for APIs.io #9

Open
picsoung opened this issue Oct 9, 2014 · 12 comments
Open

New API for APIs.io #9

picsoung opened this issue Oct 9, 2014 · 12 comments
Assignees
Labels

Comments

@picsoung
Copy link
Collaborator

picsoung commented Oct 9, 2014

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?

@picsoung picsoung self-assigned this Oct 14, 2014
@apimatic
Copy link

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

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

@picsoung
Copy link
Collaborator Author

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
Copy link
Collaborator Author

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
Copy link

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

@picsoung
Copy link
Collaborator Author

picsoung commented Nov 7, 2014

We've moved to the new API :)

@apimatic
Copy link

apimatic commented Nov 7, 2014

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
Copy link
Collaborator Author

picsoung commented Nov 8, 2014

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
Copy link

apimatic commented Nov 8, 2014

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

@picsoung
Copy link
Collaborator Author

picsoung commented Nov 8, 2014

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

@apimatic
Copy link

apimatic commented Nov 8, 2014

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
Copy link

  • 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
Copy link
Collaborator Author

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

thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants