{"id":76260,"date":"2024-08-24T22:52:45","date_gmt":"2024-08-25T02:52:45","guid":{"rendered":"http:\/\/bangla.sitestree.com\/?p=76260"},"modified":"2024-08-24T22:52:52","modified_gmt":"2024-08-25T02:52:52","slug":"how-to-use-the-swagger-editor-to-design-your-api-or-to-create-an-api-specification","status":"publish","type":"post","link":"http:\/\/bangla.sitestree.com\/?p=76260","title":{"rendered":"How to use the Swagger Editor to design your API (or to create an API specification)"},"content":{"rendered":"\n

Use the Insert menu to create\/generate misc API specification Items: <\/p>\n\n\n\n

\"\"<\/a><\/figure>\n\n\n\n

Also, watch some training videos such as:<\/p>\n\n\n\n

\nhttps:\/\/www.youtube.com\/watch?v=7MS1Z_1c5CU\n<\/div><\/figure>\n\n\n\n

Example use of the menu shown above to design your API:<\/strong><\/p>\n\n\n\n

\"\"<\/a><\/figure>\n\n\n\n
\"\"<\/a><\/figure>\n\n\n\n

You can use the above approaches or the approach below:<\/p>\n\n\n\n

—<\/p>\n\n\n\n

To keep things simple, you can just go there<\/strong>: https:\/\/editor.swagger.io\/<\/a>   (make sure to use expand\/collapse to see what I am saying below)<\/p>\n\n\n\n

You will see an editor with an API specification for a Pet store. You can just reuse this API specification and add your specification on top of that.<\/p>\n\n\n\n

One simple approach can be: think about every single object (data) that you want the users to be able to access through your API, you create a path for each such object. For each such object, you can create paths\/subpaths as the following image is showing. Here Pet, store, and user are the objects. there are multiple paths for an object such as user, user\/login, user\/logout or \/pet, \/pet\/{petID}.<\/p>\n\n\n\n

\"\"<\/a><\/figure>\n\n\n\n

Then you see under the path \/pet : some REST verbs<\/p>\n\n\n\n

\"\"<\/a><\/figure>\n\n\n\n

The for example under post (if you expand post), you see: (some stuff, you need to know\/understand, otherwise you can just follow their style)<\/p>\n\n\n\n

\"\"<\/a><\/figure>\n\n\n\n

You can do such for all object paths (for your application), additional paths for objects, and for inside object REST verbs.<\/p>\n\n\n\n

<\/p>\n","protected":false},"excerpt":{"rendered":"

Use the Insert menu to create\/generate misc API specification Items: Also, watch some training videos such as: Example use of the menu shown above to design your API: You can use the above approaches or the approach below: — To keep things simple, you can just go there: https:\/\/editor.swagger.io\/   (make sure to use expand\/collapse to see … <\/p>\n

Continue reading<\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[182],"tags":[],"class_list":["post-76260","post","type-post","status-publish","format-standard","hentry","category---blog","item-wrap"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack-related-posts":[{"id":22229,"url":"http:\/\/bangla.sitestree.com\/?p=22229","url_meta":{"origin":76260,"position":0},"title":"Java Multimedia #Root #Java","author":"Author-Check- Article-or-Video","date":"March 12, 2021","format":false,"excerpt":"Java MultimediaJava 3D API SpecificationJava Speech API Programmer's GuideJava Media Framework API GuideJava 3D API TutorialProgramming in Java Advanced ImagingJava Sound Programmer Guide From: http:\/\/sitestree.com\/?p=3256 Categories:Root, JavaTags: Post Data:2016-01-22 23:15:22 Shop Online: https:\/\/www.ShopForSoul.com\/ (Big Data, Cloud, Security, Machine Learning): Courses: http:\/\/Training.SitesTree.com In Bengali: http:\/\/Bangla.SaLearningSchool.com http:\/\/SitesTree.com 8112223 Canada Inc.\/JustEtc: http:\/\/JustEtc.net (Software\/Web\/Mobile\/Big-Data\/Machine\u2026","rel":"","context":"In "FromSitesTree.com"","block_context":{"text":"FromSitesTree.com","link":"http:\/\/bangla.sitestree.com\/?cat=1917"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":22585,"url":"http:\/\/bangla.sitestree.com\/?p=22585","url_meta":{"origin":76260,"position":1},"title":"Some Good to Know Stuff: Distributed SOA, Modular Design, API Design #Root #By Sayed Ahmed","author":"Author-Check- Article-or-Video","date":"March 16, 2021","format":false,"excerpt":"Distributed SOA Common mistakes to avoid when designing distributed SOA systems http:\/\/www.theserverside.com\/feature\/Common-mistakes-to-avoid-when-designing-distributed-SOA-systems \u00a0 Service Granularity in SOA Projects: A Trade-off Analysis http:\/\/essay.utwente.nl\/57339\/1\/scriptie_Steghuis.pdf The emergence of distributed SOA infrastructure https:\/\/skillsmatter.com\/courses\/258-advanced-distributed-systems-design-with-soa-course#programme \u00a0 A distributed service-oriented architecture for business process execution http:\/\/dl.acm.org\/citation.cfm?id=1658375 \u00a0 Restful API Best Practices for Designing a Pragmatic RESTful API\u2026","rel":"","context":"In "FromSitesTree.com"","block_context":{"text":"FromSitesTree.com","link":"http:\/\/bangla.sitestree.com\/?cat=1917"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":74240,"url":"http:\/\/bangla.sitestree.com\/?p=74240","url_meta":{"origin":76260,"position":2},"title":"Design and Engineering Considerations for API","author":"Sayed","date":"April 24, 2022","format":false,"excerpt":"https:\/\/youtu.be\/6rrknS7hB64","rel":"","context":"In "From Youtube Channel"","block_context":{"text":"From Youtube Channel","link":"http:\/\/bangla.sitestree.com\/?cat=1952"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/img.youtube.com\/vi\/6rrknS7hB64\/0.jpg?resize=350%2C200","width":350,"height":200},"classes":[]},{"id":67753,"url":"http:\/\/bangla.sitestree.com\/?p=67753","url_meta":{"origin":76260,"position":3},"title":"Key concepts for system design #By Sayed Ahmed #System Design #API Design","author":"Author-Check- Article-or-Video","date":"July 28, 2021","format":false,"excerpt":"[youtube https:\/\/www.youtube.com\/watch?v=hvIyfbfYUq0&w=640&h=480] From: http:\/\/sitestree.com\/?p=4213 Categories:By Sayed Ahmed, System Design, API DesignTags: Post Data:2016-09-26 17:10:32 Shop Online: https:\/\/www.ShopForSoul.com\/ (Big Data, Cloud, Security, Machine Learning): Courses: http:\/\/Training.SitesTree.com In Bengali: http:\/\/Bangla.SaLearningSchool.com http:\/\/SitesTree.com 8112223 Canada Inc.\/JustEtc: http:\/\/JustEtc.net (Software\/Web\/Mobile\/Big-Data\/Machine Learning) Shop Online: https:\/\/www.ShopForSoul.com\/ Medium: https:\/\/medium.com\/@SayedAhmedCanada","rel":"","context":"In "FromSitesTree.com"","block_context":{"text":"FromSitesTree.com","link":"http:\/\/bangla.sitestree.com\/?cat=1917"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":21452,"url":"http:\/\/bangla.sitestree.com\/?p=21452","url_meta":{"origin":76260,"position":4},"title":"Twitter API Search Limitations and Tools to Overcome","author":"Author-Check- Article-or-Video","date":"March 1, 2021","format":false,"excerpt":"Twitter API Search has the limitations such as You may not be able to retrieve tweets from very old dates. It may return only 1500 or from 7 days which one is earlier. \u00a0 It may return only around 20 per request. You can set rpp to get more \u00a0\u2026","rel":"","context":"In "FromSitesTree.com"","block_context":{"text":"FromSitesTree.com","link":"http:\/\/bangla.sitestree.com\/?cat=1917"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":67444,"url":"http:\/\/bangla.sitestree.com\/?p=67444","url_meta":{"origin":76260,"position":5},"title":"Java\/J2EE:Important Resources: Struts, Spring, Hibernate, JPA #Java Short Notes","author":"Sayed","date":"July 22, 2021","format":false,"excerpt":"Java\/J2EE:Important Resources: Struts, Spring, Hibernate, JPA ...... .... ..... .... ... ... ... ... ... ... .. ..Struts Struts Developer and User Guides Struts API Struts TutorialsSpring, Hibernate, JPA Spring 2.5 API Spring 2.5 Reference Manual JPA APIJSF JSF 1.2 Java API JSF 1.2 Tag Library API JSF 1.1 Java\u2026","rel":"","context":"In "FromSitesTree.com"","block_context":{"text":"FromSitesTree.com","link":"http:\/\/bangla.sitestree.com\/?cat=1917"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]}],"_links":{"self":[{"href":"http:\/\/bangla.sitestree.com\/index.php?rest_route=\/wp\/v2\/posts\/76260","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/bangla.sitestree.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/bangla.sitestree.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/bangla.sitestree.com\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"http:\/\/bangla.sitestree.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=76260"}],"version-history":[{"count":1,"href":"http:\/\/bangla.sitestree.com\/index.php?rest_route=\/wp\/v2\/posts\/76260\/revisions"}],"predecessor-version":[{"id":76267,"href":"http:\/\/bangla.sitestree.com\/index.php?rest_route=\/wp\/v2\/posts\/76260\/revisions\/76267"}],"wp:attachment":[{"href":"http:\/\/bangla.sitestree.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=76260"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/bangla.sitestree.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=76260"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/bangla.sitestree.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=76260"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}