How can I find companies and organizations' OpenAPI specifications (the JSON or Yaml file)?
Or is it simply up to each company to decide whether they want to share it with the public? (e.g. stripe: https://github.com/stripe/openapi)
Thanks.
It's up to the company. If they want users to find their specification, they will probably reference it on their API Documentation.
See for example here: https://petstore.swagger.io/
It seems apis.guru have a functionality to browse public OpenAPI specifications: https://apis.guru/browse-apis/
Related
I got the question to implement search in my Swagger UI which uses localhost.
I have been searching online and I didn't find an answer for this.
My question is: "Is it possible to implement search in the Swagger UI, so people can search for a path of the API?"
Thanks in advance!
I have received an answer on the official Swagger community page on Google groups.
They suggested the following page on github and this was just what I was looking for. It is a very nice looking search implementation in the Swagger UI.
https://github.com/swagger-api/swagger-ui/pull/2116
Anyway thanks for answering to my question!
This swagger-ui don't have a ui-search option so far. But as a solution you have 2 options.
By default swagger-ui list down the set of apis based on the paths (annotated by #Api() on api code). In the below example it has listed down apis based on 2 paths (price-checks and pdp-details).
2.You can explicitly tell swagger-ui to only show apis listed under specific path. In below example, it shows apis listed under price-checks only.
To do that, you have to configure that path-doc with swagger.
Refer this for more info about swagger-annotations.
UPDATE:
In- built swagger-ui search is now available.
There is a repository in githubswagger search that can search API's across projects and search API in swagger document by command(ctrl)+F.
I'd like to be able to add a user as a guest to a project specific to that individual, but it looks like I cannot do this programmatically and must instead resort to manually adding them as a guest. Is there anything I'm missing in the API documentation? Is there an undocumented feature that would let me do so? Or am I just out of luck?
It is currently not possible to manage users of an organization via the API.
This is on our API roadmap, which I hope to publish a public version of soon.
You can subscribe to incremental changes of our API and it's documentation on API changelog https://www.apichangelog.com/api/asana
I'd like to know if the following is possible.
Swagger is almost what I need to document a Message based API. For instance for a Command Message I'd like to say "Command" instead of "Post", and instead of "path" I'd like to have the name of the Command.
The spec mentions that Vendor Extensions are possible using "x-" properties but I am 1) not finding any examples of how to do this and 2) not sure if the use of these properties would help me meet my goals.
Might anyone be able to point me to some resources that can help me move along?
Swagger is designed to document REST APIs which are based on HTTP verbs. You can't replace verbs or invent new ones.
Vendor extensions are there to allow adding additional information that the specification does not allow, but ultimately, it is still intended for REST APIs.
From what I gather, you're trying to describe something different.
We do welcome suggestions for additional roads for Swagger (that is, cover non-REST APIs), and in order to do that, I'd suggest opening an issue on the swagger-spec repository.
I write the application on Node.js and I need to get information from the forum, which works on the engine IP.Board. I decided to use XML-RPC API. On this issue there is an article In the administrative tools set support for XML-RPC API on the website of the IPB. I managed to get some information through the API, but I don't know how to authenticate a user.
My actions:
In the administrative tools set support for XML-RPC API
Add user and allow to perform all methods
Copy the key and use in my application
But when it comes to posting on the forum from outside I have trouble . Read the article linked above:
method postTopic
member_field: This should be the field to look up the 'member_key' in
(for instance, 'member_id', 'email', 'members_display_name', etc.)
member_key: The value to search in 'member_field' with in order to find the poster. You may pass member_field as ID and member_key as
1, for instance, to post a topic as member ID 1.
forum_id: The ID of the forum to post the topic in
topic_title: The topic title
post_content: The contents of the first post
Now I need to know the ID of the user on whose behalf to publish a post. How to know this?
I had a similar problem and simple solution is not found. You can write your extension for IPB and implement the necessary APIs themselves. Using IPB XML-RPC API (at the time of publication of the question), you can only yourself to find out the ID of a user and on his behalf to make the publication, publish answers or use other available options. For example, automatically check the availability of offensive language in the message and answer any warning.
I want my Rails App to parse external websites for a trackback URL but I'm not really sure if I should just look for a
Text
or follow the RDF specifications described by sixapart. Or both. Wordpress and Techcrunch both only offer a rel="trackback" link and they should know. On the other hand maybe some blog only provides RDF and I'm missing the link.
What do you think?
And is there any ready gem/plugin out there (it's really hard to google for trackback...)
Thanks.
UPDATE
I'm now first trying to find the RDF information. If I do not find anything, I look for the link tag. I was refering to the sixapart specifications. Thanks for your help.
I'm checking for both now (first RDF, then link if not successfull). I was refering to the sixapart specifications. Thanks for your help!