Content deleted Content added
m Signing comment by TvojaStara - "→Renaming; it is not much of "science": new section" |
→Sample code: Thanks for the examples link. I see that they can express the API as at least JSON and YAML. That should be in the article. Perhaps a JSON version compacted to not put lines with only one bracket or the YAML version could fit in the article. The [https://learn.openapis.org/examples/v3.1/non-oauth-scopes.html non-oauth-scopes] example is small enough, but not very clear, I think. |
||
| (19 intermediate revisions by 17 users not shown) | |||
Line 1:
{{WikiProject banner shell|class=Start|
= Joke? = ▼
{{WikiProject Computing |importance=Low |software=y |software-importance=Low}}
}}
== Product Sheet ==
This reads more like a product sheet than an article talking about what it does and how. Like it was written by a marketing team from salesforce/mulesoft. It does cool stuff and slices your bread. <!-- Template:Unsigned IP --><small class="autosigned">— Preceding [[Wikipedia:Signatures|unsigned]] comment added by [[Special:Contributions/104.245.226.203|104.245.226.203]] ([[User talk:104.245.226.203#top|talk]]) 02:51, 22 June 2020 (UTC)</small> <!--Autosigned by SineBot-->
▲== Joke? ==
Is this a joke?
:No, RESTful APIs have had a problem of no standard documentation format. Swagger attempts to address this problem. [[User:Ebeisher|Ebeisher]] ([[User talk:Ebeisher|talk]]) 22:01, 5 January 2015 (UTC)
:The article is incorrect (unfortunately, 99% of the world misuses the term REST --> Richardson Maturity Model). Proper REST does not need additional documentation. Therefore you should replace REST with JSON API. [[User:Michel.reuteler|Michel.reuteler]] ([[User talk:Michel.reuteler|talk]]) 13:19, 27 September 2022 (UTC)
== Renaming; it is not much of "science" ==
Swagger is an API description language and a set of software tools for working with that language. This article should be IMO titled "Swagger (software)". <small><span class="autosigned">— Preceding [[Wikipedia:Signatures|unsigned]] comment added by [[User:TvojaStara|TvojaStara]] ([[User talk:TvojaStara|talk]] • [[Special:Contributions/TvojaStara|contribs]]) 11:46, 14 March 2015 (UTC)</span></small><!-- Template:Unsigned --> <!--Autosigned by SineBot-->
:I think it is appropriate that the page was moved back to "OpenAPI Specification". The spec is now owned, authored and implemented by many companies beside Swagger, as documented at https://openapis.org/. [[User:Nealmcb|★NealMcB★]] ([[User talk:Nealmcb|talk]]) 23:34, 21 April 2016 (UTC)
== Wordnik ==
I have removed references to Wordnik, as I could not find a reliable source that documents its involvement. However, after some research, I found a mention on the Tony Tam's (creator of Swagger) [https://www.linkedin.com/in/tonytam/ LinkedIn Page].
"Wordnik was the creator of the Swagger UI for http://developer.wordnik.com which has become the de-facto technology for REST APIs."
However, LinkedIn page is not a reliable source. If anyone can find a reliable source, please amend the article accordingly.
<span style="border: 1px solid #C90016;background:white">[[User:Kinkreet|<b><span style="colour:#002147;">Kinkreet</span></b>]][[User talk:Kinkreet|<sup><span style="colour:#993333;">~♥moshi moshi♥~</span></sup>]]</span> 11:12, 19 October 2017 (UTC)
:Here is link to initial version of "Swagger-UI" README.md that have Wordnik copyright in it https://github.com/swagger-api/swagger-ui/blob/f126a73d9923de3c5eac5ada99601a745bf19e92/README.md#license [[User:Ivan Goncharov|Ivan Goncharov]] ([[User talk:Ivan Goncharov|talk]]) 09:49, 27 November 2017 (UTC)
== Neutral point of view issues/promotional tone ==
<pre>Sponsored by SmartBear Software, Swagger has been a strong supporter of open-source software, and has widespread adoption.</pre>
--[[User:Tuxayo|Tuxayo]] ([[User talk:Tuxayo|talk]]) 02:52, 1 July 2020 (UTC)
== Ankward sentence ==
The following sentence seems to be incorrectly structured.
{{Quote frame|By taking as an input swagger and some other tools can generate code, documentation, and test cases from OpenAPI Specification compliant files.}} [[Special:Contributions/80.112.158.40|80.112.158.40]] ([[User talk:80.112.158.40|talk]]) 07:01, 7 November 2023 (UTC)
:Agreed! I've edited to improve it (hopefully). [[User:Earth2marsh|Marsh]] ([[User talk:Earth2marsh|talk]]) 21:34, 27 November 2023 (UTC)
== Sample code ==
Can we have some sample code such as a [[Hello World]]?
-- [[User:Error|Error]] ([[User talk:Error|talk]]) 20:40, 20 January 2025 (UTC)
:@[[User:Error|Error]]the OpenAPI Specification is a specification not a programming language or any one tool (there are many tools that use the specification for a variety of purposes). The OAS is not a very concise format, so embedding an example API description (similar to those on OpenAPI's [https://learn.openapis.org/examples/ learn site]) would take up a lot of space and require a more in-depth article to explain what the example means. It's not clear to me if it makes sense to go into that much detail on a wikipedia article. (Although if someone sees a good way to add an example here, please do not let my comment stop you!)
:[[User:Ixat totep|Ixat totep]] ([[User talk:Ixat totep|talk]]) 16:35, 21 January 2025 (UTC)
::Thanks for the examples link. I see that they can express the API as at least JSON and YAML. That should be in the article.
::Perhaps a JSON version compacted to not put lines with only one bracket or the YAML version could fit in the article.
::The [https://learn.openapis.org/examples/v3.1/non-oauth-scopes.html non-oauth-scopes] example is small enough, but not very clear, I think.
::-- [[User:Error|Error]] ([[User talk:Error|talk]]) 02:21, 23 January 2025 (UTC)
| |||