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

[Blog] added blog for swagger #654

Closed

Conversation

abhishek-iiit
Copy link

@abhishek-iiit abhishek-iiit commented Apr 15, 2024

What kind of change does this PR introduce?
Blog Post in Engineering section

Screenshots/videos:
image

Summary
This blog introduces the concept of combining Swagger with JSON Schema.

Does this PR introduce a breaking change?
NO

@abhishek-iiit abhishek-iiit requested a review from a team as a code owner April 15, 2024 09:32
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to the JSON Schema Community. Thanks a lot for creating your first pull request!! 🎉🎉 We are so excited you are here! We hope this is only the first of many! For more details check out README.md file.

@gregsdennis
Copy link
Member

Thanks for the submission, but this, to me, feels like a Swagger (and its editor) tutorial.

Yes, Swagger uses JSON Schema, but there's nothing in this about using or writing JSON Schema or how it's related to describing APIs or generating docs.

It feels like it'd be a better fit for their blog (or an independent one).

Secondarily, is Swagger still a thing? Since Swagger (OpenAPI v2.0), there have been two releases of OpenAPI, 3.0 and 3.1, and they're planning on releasing v4 soon.

@abhishek-iiit
Copy link
Author

Hi @gregsdennis
Thanks for the review, actually there are 2 methods to write Swagger documentation for any endpoints through

  1. YAML
  2. JSON
    Since, with JSON we have many advantages over YAML, so created a one with the powerful capabilities of JSON, the blog is irrespective of any version of swagger we use today 😄

Looking forward to create better blog with the json-schema's 🤩
Feel free to close this PR 🙂

@benjagm
Copy link
Collaborator

benjagm commented Apr 15, 2024

Thanks for the PR @abhishek-iiit . Closing this PR as discussed.

@benjagm benjagm closed this Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants