Shortcut URL to the latest version of an API doc?
I have published links to our SwaggerHub API documentation page (e.g., https://app.swaggerhub.com/apis/strangecode/AnchorNW/1.0.0) in many locations in our website and internal documentation. I noticed if I update the version of the API, e.g,. a patch change from `1.0.0` to `1.0.1`, the URL will change to `…/AnchorNW/1.0.1`. This means I have to update the URL linking to this page everywhere in was used every time the version increments. Is there a shortcut URL that automatically loads the latest version of the API? E.g., `…AnchorNW/latest`? If not, this would be a very useful feature. Thanks!Standardization across organizations - PLEASE VOTE UP :-)
Hello Smartbear, Could you please enable a feature of allowing standardization ACROSS organizations? (On premise version) This would solve a lot of stuff in the way we are trying to use this feature and would allow us to organize and categorize our APIs in a more efficient way. Thanks a lot. thanks for voting up👍👍👍 Kind regards, Adriaan
Adding terms-and-conditions for SwaggerHub Saas/Cloud
For the SaaS SwaggerHub is there is no option to- Add terms-and-conditions SwaggerHub On-Premise has this option https://support.smartbear.com/swaggerhub/docs/enterprise/v1/config/terms-and-conditions.html?sbsearch=login%20page Since this feature is already available in the “On-prem” version, it is not too much of an ask to incorporate this in the “SaaS” version. Many organizations are required to inform their users that they are leaving the internal network and going to the external cloud. This feature would be very helpful to inform our customer every time they login along with other critical terms.
Feature Request: Use own domain (URL) for UI
I'd like to be able to use my own domain for the UI and the swagger spec itself. What I'd like is something similar to what Read the Docs does. Everything is still hosted on their site, it's just accessed using one of my domains. As an example, I'd like something like swagger.example.com, where example.com is a domain I own, to be the base URL for the swagger UI for my APIs.
Persistence of Integrations at the API (not version) and organizational levels
We have several APIs and in order to integrate these with Azure and BitBucket, I have to provide the integration details on every API version; which gets daunting. I'd like to be able to set this at the API container level or organization level so I don't have to reset them again.Include API name and version in email notifications
Currently, whenever a comment is made on an API with which I'm associated, I receive an email notification with a subject that is something like "gareth.davies has just addeda comment to your API" (similar for replies). Since, as an Org Owner, I'm associated with dozens of APIs it is unclear from the email Subject alone which API has been commented on. Is there any way of including the API name in the Subject line?
Each Organization should have an editable wiki page
Each organization should have a wiki page - or at least a stored/clickable URL to enterprise wiki/confluence - so that viewers/developers can get to general doc page of info about the org, dev policies, services standards, etc, whatever. The link would be visible (if set) on the main org API listing page, under the org name. Also in the API editing page in the pulldown section (which lists owner/created by/created date)Some feedback
Sort order needs to be remembered (ideally it would be remembered across sessions - I almost always want the list sorted by name, not by changed date). - Change the sort order - Click on one of the API's - Click the <- arrow to go back to the list. - Click on the API / Domains on the left menu, suddenly it has reset back to sort by change date. It would be nice if the column to the right of Summary info/Tags/Servers on an API was collapsible (so you could see the info in the list and the full API - you don't always need the summary/tag/server details). This would let you still click on the API methods to scroll to them but not take up horizontal space. It would be nice if there was a way to see where (which API calls) a given model/schema was being used in. Your plan pricing is weird. Only 20 API's for a plan that can have up to 3 designers? We're a tiny team and we're already at 17 of them just after loading the API's provided to us from one of our third-party vendors. We won't even have enough API's if we start importing our own. Our main use case for the site is being able to easily share/view the Swagger docs provided to us vs. us designing our own (which, even if we wanted to, we couldn't use because of the really low API limit). It would be more useful if the "Search within MyHub" could search within the API's as well. We run into the scenario where we are looking for something within a microservice and can't remember which one of the 17 different Swagger docs we have has a particular API call. ex. we might know it's called "validate" (something) but can't remember how the vendor organized it. Right now we have to click into each API and look for it / use the search from there.SwaggerHub page title change request
Hi A single page title across all pages of "Build, Collaborate & Integrate APIs | SwaggerHub" gets really tiredwhen working in multiple browser windows. Please could you change the page title to the name and version of the thing in the page? E.g. Acme Domain 2.0.3. Here's a story for you: When working in multiple windows in SwaggerHub, I wantthe browser page title to describe what's ineach tab, so I can navigate to the correct one without having to guess. Rod
Show multiple-list selection in swagger UI template examples (petshop)
Hi! Would be great to show the pet shop example with multiple list example for parameter selection. schema: type: array items: $ref: '#/components/schemas/MyEnumList' components: MyEnumList: type: string enum: [AllowedParameterValue1, AllowedParameterValue2,AllowedParameterValue3] reason: i googled for it but could only find:https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#style-values which was not really helpful as example. but thanks to really great supporthttps://swaggerhub.drift.com/Natalie_Borovykh ;-)Validating mandatory fields
Could we add some validation that verifies attributes marked as mandatory are actual attributes present in the data definition. If you make an error when typing these the editor doesn't catch it as an error, the only way to see this is to review the model and verify the mandatory fields are correct. Quite a simple change but something that has caught me out several times when I've misspelled an attribute or used the wrong case!
SwaggerHub Pause Integrations Option
When working on an API in SwaggerHub with multiple integrations, every time I update the API, each integration kicks in (pushing multiple commits to GitHub, updating AWS, etc). In order to iteratively work on my API in smallsteps, I need to disable each integration one-by-one, and then re-enable them one-by-one when I get my API where I want it to be. It would be useful to have a fast (one-click) wayto disable and then re-enable all integrations so that I can work on my API withoutthrashingmy integration targets.Need Mocking API to be able to control the case for the mock example
An API can support several response codes and projections even in an Idempotent operation. For clients which expect to use the API and mock out the cases, they need to be able to control what case (response) their attempting to exercise. Having the mocking VertServer cycle through the possible response examples doesn't allow the api developer / integrator or testerto have reproducible results (manually or programmatic ally). It would be nice if, when making a request, the client could provide a header describing which response case it would like to exercise. It would also be nice if the virt server baseUrl was not stored as part of the contract and could be turned on or enabled on a request basis so administrators wouldn't have to change the contract just for a client / team to test the mock contract.ASPNet5 Code Generation: Separate resource files for API operation descriptions
The generation of c#puts descriptions in the <Remarks> tag for the operation on the controller. This is ok but it tends to pollute the code and doesn't preserve the white space of the markdown. We'd like to have swaggerhub generate resource files that we can link into our c# micro-service and use the swashbucke IDocumentFilter to read those files from code resources and provide them in swagger output. This would also allow us to handle localization concerns in the future much more effectively. Why: because once we generate the code, we push our micro-service through our continuous delivery process and only publish to our gateway from the micro-service host swagger. So the format of those descriptions need to be maintained and presented by the code itself.Multi-Edit capabilities
Currently when two or more editors are editing an API swagger, they get a notification that both are editing and one will lose their changes. Editors / Commentors won't editor or comment when it happens for fear that they could overwrite some import changes made by the other participants. Feature: Confluence has a feature where you can see when the other user is editing the same document so you can be sure you're not working on the same changes. It would be great if we could either get a) detection and merge capabilities when saving for multi-editing or b) realtime view of editing by multiple parties.
Darshan Hiranandani : Automating API Design Diagrams from Swagger Specs
Hi Team, I’m looking to create an API design diagram that visually represents the relationships between endpoints, as well as their requests and responses. I believe using Swagger (OpenAPI) specifications could help achieve this automatically. Here’s what I’m aiming for: Visualize the relationships between different API endpoints. Show the requests and responses for each endpoint. Define how parameters and attributes relate across different endpoints. Does anyone have experience or recommendations on how to automate this process using Swagger specs? Specifically: Tools and Techniques: Are there tools or platforms that can generate API diagrams from Swagger specs? Customizations: How can I specify relationships between parameters and endpoints within Swagger specs to be reflected in the diagram? Best Practices: What are the best practices for setting up Swagger specs to ensure accurate and useful diagram generation? Any insights or suggestions on achieving this would be greatly appreciated! Thank you, Darshan HiranandaniDarshan Hiranandani : How does the "Pause Integrations" option work in SwaggerHub?
Hi Team, When working on an API in SwaggerHub with multiple integrations, I face a challenge where each update triggers all integrations, resulting in multiple commits to GitHub, updates to AWS, and other actions. To work iteratively on my API, I find it cumbersome to manually disable and re-enable each integration one by one. It would be incredibly useful to have a quicker, one-click method to disable and re-enable all integrations simultaneously to avoid frequent disruptions to my integration targets. Could anyone suggest a more efficient approach or workaround for managing integrations in SwaggerHub during development? Any tips or solutions to streamline this process would be greatly appreciated! Thank you for your help! Best regards, Darshan HiranandaniAPI diagram design automatically
Hi, I am looking to build a API design diagram where I can see the endpoints relations, requests, response visually. With Swagger spec, I think it could be posible to implement it automatically. Defining a way to specify what parameter is a related attribute to other endpoints. With that in place, building a diagram automatically from the specs, would be feasible. That’s it make sense? Thanks youReal move API from Organization/project
Hello I am using SwaggerHub on-premise. When manipulating APIs, I can use the following: - Fork API file to org/project - Manage Owner and project For example, I can move an API from organization to another within the wanted project. However, when doing the same, for thesame organization but within another project, it keeps the API in the original project and adding it the target project. It will be cool to really move an API from project to project, within the same organization, and keep only the target project. thanksOAS validator within SwaggerHub
Hello My company is using SwaggerHub On-Premise and APIGee as API gateway. We implemented some "Standardization" rules to validate the OpenAPI file syntax within the YAML IDE. Then we run a separated API provided by Google, to validate the OpenAPI file and services logic (here) It would be great to have this validator simply imbedded as an option of the SwaggerHub IDE. By the way, we had cerate a webhook to run it as an integration. Thank you
Don't reveal SwaggerHub APIKey in requests from SwaggerHub Integration for Confluence
Could you please consider proxying any authenticated calls from the Confluence page to the SwaggerHub API back through the domain that you presumably serve the widget content from (https://confluence-plugin.swaggerhub.com)? I'm not sure what constraints exist with the Confluence plugin model, but hopefully this would allow you to manage all sensitive state (ApiKey storage) externally in a location we already trust, and form the appropriate authenticated requests to the SwaggerHub API from there. As things stand right now, the SwaggerHub API requests are observable using browser dev tools as the Confluence page renders. These requests include the chosen SwaggerHub ApiKey in the authorization header. This is a security concern for us as we have external parties and partners who we grant visibility to areas of our Confluence tenant so they can view documentation which includes api specifications. Once the ApiKey is compromised, the holder has far more than the readonly-access to specific API specifications that we intended. There are probably other ways to address this, but the proxy approach seemed the most pragmatic to me. We've worked around this issue in the past with other Confluence swagger plugins by only using exported specifications that are attached to the page. However, you are in a good position to allow the convenient referencing of the api specifications in their natural home in SwaggerHub, while keeping the communication paths secure.Allow resolution/selection of API version in SwaggerHub Integration for Confluence
Would be useful to allow just the base url to a SwaggerHub API to be specified in the widget configuration. For example: https://api.swaggerhub.com/apis/acme/products Rather than:https://api.swaggerhub.com/apis/acme/products/1.1.0 When the Confluence page is later browsed (and assuming the url is to SwaggerHub), then the default API version should be automatically resolved. This would allow the current state of the API to be reflected in Confluence without requiring new edits every time a new version is published in SwaggerHub. An extension to this would be to allow the users to choose from the different published versions when browsing the page. This should be an opt-in feature on the widget configuration.
Support for teams in user-management-api.
The User Management and Registry AIs are very useful - but I'm missing any way of viewing or manipulating team membership. For a specific use case - my organisation is shared among a number of teams that don't have much to do with each other. I want to be able to do things like report on all users in a team, the type of license currently assigned to them, and when they last logged in. The user management API allows me to do most of that, but I can only get the results for the entire organisation - I can't limit it to just the users I'm responsible for. So, the two main things that would be useful: The existing operation for listing organisation members needs a "filter by team" parameter. Some new operations are needed for listing (and optionally, modifying) the members of a team. It would also be nice if "last active time" was one of the sort options for the API.Provide support for Cyrillic symbols in the properties description, when using Markdown list.
Hi! I`ve found something interesting. Icant makeMarkdown list option in the properties description when i`m usingonly Cyrillic symbols. To do this i have to take first symbol from Latin alphabet. For example, here is the description with first Latin char: As we see, it`s Ok. But, if i insert Cyrillic char as a first symbol, the list is being destroyed:API to upload templates
Currently, the developers have a pipeline that acts like a user and uploads generated templates to SwaggerHub. It would be nice if this was an official API route so we are not burdened by UI changes that might break our process. Part of the purpose is so we can validate in our staging SwaggerHub that our end to end flows are working properly. We also trigger a maintenance restart as part of this process for the templates to appear in the UI. Please let me know if you need more detail.Cannot put members that didn't accept the invitation yet to the teams created.
With multiple users invited that means that the admin/owner needs to log in every day to check if someone hasaccepted the invitation and the appropriate team should be updated. Especially tricky with users/consumers from other companies.
Better Model Documentation / Generation
It would be very useful Models could be given tags so that the documentation could group them the same way that the endpoints are grouped. Then in model generation, instead of all of the models in the model folder, they could be split up into sub folders in the model folder. Not sure if this is swaggerhub Idea, or more for the swagger-generation/swagger-editor repositories, but this is something I would like swaggerhub to do.SwaggerHub to generate a Pull Request to Github
Currently we can push to a branch in github the swagger file only. It would be great if we could also have the ability to create a branch and submit a PR at the same time. This would allow my developers to review and feedback. Having the PR status with the swaggerhub UI would be good tooChanging prefix for generated files on Client SDK generation
[Please redirect to right 'location' if this is not the correct one = thanx in advance] When I download the client SDK for integrating with the API. However all the class names are named with prefix as 'Swag'. If I have to integrate with multiple APIs, I would like the API name to be reflected. Example CufxClient instead of SwagClient or CufxSwagClient instead of SwagClient.Compare option - trouble in the display
We have a marvelous tools to help us comparing the modifications between two api versions. But, currently, the comparaison popup can not be resized. At the end, the usage of this functionality is very restricted. My suggestion is to allow the possibility to resize the comparaison popup.swagger and openApi extented notations "x-"
It s possible to extend the fixed fields in a schema. The specification indicate that we just need to prefix the extra fields with "x-". It s a good point if we want to specified spécific informations - per example the data source of a field. But, in the produced documentations, at the end, we never see this extra fields. My suggestion is, optionnaly, we can add/display this extra fields in the final documentation. Currently, this is what we have : We can expect that we can see the extra field x-dataSource in the documentation.Add SwaggerHub to generate springboot code from api
Hi , Please add Add in SwaggerHub to generate springboot code from api and also provide documentation in your help. Just gone through the spring codegen tool on SwaggerHub and the code genrated project structure is not as per the standard abbreviations and nomencleture we following for RestFul APi project. With Warm Regards Om PrakashGeneration of Schema from API specification for model definition
I understand the model definition is part of Open Api specification, but this definition just helps in reference and not usable at all both for consumers and provider. Just like we can generate the code stub from the specification it will be great if we can generate schema definition in json schema with the versions.WSO2 Integration with SwaggerHub
SwaggerHub gives the opportunity for the users to integrate with several API Management platforms.WSO2 API Cloud is a public hosted version of award-winning open source WSO2 API Manager. It enables enterprises to quickly share their business capabilities with their customers and partners across the globe. It would be great if we could add it as an integration to SwaggerHub. Thanks.SwaggerHub: LDAP Integration for On-Prem
We need LDAP Integration for SwaggerHub. Currently, users have to manage an additional user credentials. With most of the products being LDAP-Integration enabled, we would like to expect the same for SwaggerHub. What plans do you have for this to be available?
SwaggerHub Feature Requests
52 Posts
