Contributions
Re: Url parameters in path and query
Hi Helena, again ... that worked very well. Thanks a lot! non-the-less I have another question with regard to the layout.... would be grateful if you can get me started one more time. Before I just created an html2-client. It looked a bit different to the right (display-) side of the swagger editor but it had a vertical menu on the left side. Now I followed your instruction a delivered 100 % of what I had asked for, but is there a way to a navigation bar ? Can you tell how to get that ? Best Thanks! Thor5.5KViews0likes1CommentRe: Url parameters in path and query
Hi Helen, that helped me a great deal! Thanks a lot! Similarly like you posted I used the parameters. In the editor it looks pretty good. Completely the way I wanted mit (please see attachment editorversion.PNG). Than I created html2 - client an put on my server. But than it looks differently (please see attachment readyclient.PNG). Sorry for this beginner question, but can you tell me, what has to be done in order to create a client / html-site, the looks the same way like the editor version ? Thanks a lot ! Best, Thor5.5KViews0likes3CommentsUrl parameters in path and query
Hi there, our api allows path parameters only. Like so : ourdomain.com/api/v1/param1/param2/param3/param4/ "param4" is subdivided in parameters. They serve more or less as filters. Sub parameters may be "begin", "end", "format" and others. "begin" and "end" are e.g. unixtimestamps "format" could be "xml". ourdomain.com/api/v1/param1/param2/param3/begin-1560730667,format-json So the "param4" are more or less query parameters. A similar implementation with query parameters would be: ourdomain.com/api/v1/param1/param2/param3/?begin=1560730667&format=json So my prob is how to document our version. In our version param4 would be single path parameter and therefore required. But it is of course not required. So is there a way to document our version with swagger. That means to describe param4 as not required or better describe the sub parameters. If I declare param4 as "in query" of course it produces something like: ourdomain.com/api/v1/{param1}/{param2}/{param3}/?param4= which is not what I want. Thanks a lot ! Best, ThorSolved5.6KViews0likes5CommentsBasic Swagger Question
Basic Swagger Question Hi, "Getting Started with Swagger" should be the right subject to this post too ... but I did not find the answes to my questions in the other thread... With PHP we developed a REST - API and want to provide a documentation. The API is not that complex. Only a few controllers. Our data: $ $ sudo node -v [sudo] password for myuser: v8.10.0 $ sudo npm -v 3.5.2 $ $ sudo lsb_release -a [sudo] password for johann: No LSB modules are available. Distributor ID: Ubuntu Description: Ubuntu 18.04.4 LTS Release: 18.04 Codename: bionic $ I downloaded swagger like so: git clone https://github.com/swagger-api/swagger-editor.git swagger-editor-doc So I can play around with a documentation vai the editor on my own server: https://myownserver.com/swagger-editor-doc/ But where can I see the documentation (like this one : https://petstore.swagger.io/ ) on my own server ? Can you get me started on how to create my first own docu ? What are the steps ? Prerequisits Do I need other versions ofe npm etc. ? Can I edit it manually in the swagger-editor or does swagger generate it from the source code? Thanks a lot Best, Thor519Views1like0Comments