I have to document the REST APIs for one of the application using the Swagger Editor. I have gone through few of the references available but nothing seems to show the start point on Documenting the APIs.
https://swagger.io/docs/swagger-tools/#installation-11
Have downloaded the Swagger Editor and want to start on documenting.
Any specific pointers to start on it would help.
Thanks.
With Regards,
-Nayan Parikh
I was able to start on the documenting the APIs. Following are the steps that i followed hope this would help someone in need.
Documenting using Swagger-Editor
Open the Swagger Editor online https://editor.swagger.io/
OR
Download from the link https://github.com/swagger-api/swagger-editor
Go to the folder swagger-editor and Run the index.html
This will open up the editor and start documenting the API based on the specification mentioned at https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
Once that is done download the it as JSON or YAML file.
Viewing it on Swagger-UI
Download the swagger-ui from the link https://github.com/swagger-api/swagger-ui
Go to the dist folder and Edit the index.html.
Specify the JSON/YAML file you just downloaded above.
Check it by running the index.html
Hope this helps
Thanks.
Related
I just recently started using Sandcastle Builder, I am wondering if there is a way to publish the generated index.HTML to a web host so it can be seen from any browser.
Thanks
This is possible and you may want to give it a try.
I generated a dummy help including some conceptual topics for testing in other context. So, navigate and open the uploaded files from server Sample Web Help and see what happens.
Go to Project Properties > Build and check Website as shown below.
After you have successfully generated your help project you will find all files for upload. The default is a .\Help folder relative to the project folder.
The following screenshot shows the structure of the generated WebHelp for the link above.
I'm using ember-cli and I made a custom component using ember-cli syntax & naming conventions. This is a highly reusable component and I'd like to know what is the better way to put it all into a "package" so it's easy to integrate into other projects.
My component use a .js file for the Ember.Component subclass along with a .hbs file for the template and yet another couple of .js files for the necessary Ember.View subclasses. Right now, every file is in its respective folder along with the files for the rest of my project.
How can I isolate the files related to the component and package them for reuse? In Ruby on Rails I use gems for this matter, and in jQuery I used to write plugins by extending $.fn in a single file.
Take advantage of Ember CLI addon system. It's been designed for cases like this one. The process should be easy if you are familiar with Ember CLI already. As Ember CLI addon system's been reworked in the recent past and it's API was changing it's possible that older articles or guides on this topic became out of sync.
The most comprehensive and kept in sync guide on this topic is kristianmandrup's gist Converting libraries to Ember CLI addons.
There is also an Addons tutorials section on the official Ember CLI site.
I can't find a free repository allowing to distribute Eclipse Update Site.
The main requirement is that it should provide access to raw content so that Eclipse can use the URL to retrieve all the binaries of my projects.
GitHub provided access to raw url but it seems it stopped.
Do you know if bitbucket does it? any different solution?
Actually, you can host an eclipse update site easily on github using raw url. I know because I have done it recently and it works.
It is true that you get a 404 when you try to access the repos 'raw' directory. However, that is actually not a problem because when you use the Eclipse (or Marketplace) installer to install something from an update site the installer does not access the folder directly. Rather it will only access files like 'catalog.xml'. This means that if you point the Eclipse installer at your raw update-site folder then it will be able to read the contents of the site without any problem.
Here is an example:
https://github.com/kdvolder/thirdparty-p2-repo/tree/4bb37ca4de6cd001f400c2913421b8c4b49538e1/target/repository
The corresponding raw url is this:
https://raw.githubusercontent.com/kdvolder/thirdparty-p2-repo/4bb37ca4de6cd001f400c2913421b8c4b49538e1/target/repository
Yes, that will give a 404 when you click it. But that is okay, just open "Help >> Install New Software" and paste the link into the "Work with" field of the dialog and it works fine:
It works because raw urls like this one are all the installer needs:
https://raw.githubusercontent.com/kdvolder/thirdparty-p2-repo/4bb37ca4de6cd001f400c2913421b8c4b49538e1/target/repository/category.xml
Github also allows this. You need to create github page and upload your p2 repository there. On the website github pages is explained how to achieve that. Just scroll and the steps will appear on the page (fancy javascript). For your project there is a second repository, where you have to put your repository.
I prefer to use sourceforge for the update site of my Eclipse projects. I recently published a blog post detailing all the steps to achieve that http://www.lorenzobettini.it/2015/01/publish-an-eclipse-p2-repository-on-sourceforge-with-rsync/
I'm interested in creating a NuGet package for a documentation tool I'm writing. Ideally, I'd like the user to not have to configure my tool in anyway. In order to do this, I need to be able to read some settings from the Project's .csproj or .vbproj file to get the path of the Xml documentation file generated by the compiler. I also need to add a post-build step to the project.
I've looked through their documentation but I haven't seen any mention of being able to do this. Is this possible? If so, is there any documentation or examples of this available?
Using PowerShell script, you can access the rich VS DTE object model. This allows your package to do all kind of things that NuGet doesn't have specific features for. Look at this help topic for some info on using init.ps1 or install.ps1.
I have created a web part using VSeWSS 1.3. It creates a wsp file and my web part gets installed, everything works great.
I would like to also create a folder in the LAYOUTS directory of the 12 hive and place a couple files in there. How do I go about doing this? I know that I can manually place the files there, but I would prefer to have it all done in one fell swoop when I uses stsadm to install my solution.
Is there a best practices guide out there for using VSeWSS 1.3 to do this? They changed a bunch of stuff with this new version and I want to make sure I don't mess anything up.
You can create a new folder structure in your webpart project, like:
Templates/Layouts/CustomFolder and put your files in the CustomFolder directory and include them in your project.
When you go to the WSP View in Visual Studio, you can see in the manifest.xml that your files are being included in the deployment.
I have done this successfully on multiple projects now.
In case anyone is wondering, the VSeWSS 1.3 user guide is incredibly helpful. It is installed to the same directory as the tool itself, default in C:\Program Files\Microsoft SharePoint Developer Tools 9.0\VSeWSS13.CHM
You can see a working example with screenshots Here
A simple step-by-step tutorial for the above, along with deploy/retract scripts is here at Add New Files To 12-Hive Through A SharePoint Solution. Just follow the steps and in a few minutes you'll be able to add whatever you want to the 12-Hive!