Portal Documentation
Guides and reference material for Portal.
Release Notes
Overview
Get Started
Role Management
Provider View
- Provider ViewThis section explains the functions and layout of the provider view. Read topics in this section if you are new to Portal.
- Portal Configuration PageUse this page to set up your portal's general appearance and URL.
- Top MenuUse the top menu to:
- General TabUse the general tab to configure:
- Appearance TabUse the appearance tab to configure:
- Custom CSSThis guide explains how to write custom CSS for the SwaggerHub Portal consumer interface, covering the selector API, property allowlist, dark mode,…
- Token Variable and Generic Component ClassesThis section explains the semantic theming tokens the portal exposes, the shared component classes, and how the portal scopes your custom CSS before it is…
- Selector APIRules must target at least one .sp-* class from the tables below. Every .sp-* class in a selector must be from this list. Unknown classes are rejected at…
- List of Properties Allowed and Dark ModeThis section lists the CSS properties the validator accepts and explains how to write dark mode, pseudo-class, pseudo-element, and responsive rules in…
- Cascade BehaviourThis section explains how custom CSS interacts with the portal's existing styles and gives component-specific guidance for prose content, the API viewer,…
- Limitations and Best PracticesThis section covers what custom CSS cannot do, how to diagnose rules that do not take effect, and recommended practices for maintainable, brand-consistent…
- Accessibility and quick-start templateThis section covers the accessibility requirements custom CSS must meet and provides a starter stylesheet you can adapt to your brand.
- Landing Page TabThe Landing Page Layout panel shows where the description and the products appear on the landing page in light mode and dark mode.
- Footer TabIn the Footer tab, you can customize a footer that is displayed at the bottom of your portal. You can use it to provide your users with helpful…
- Custom Domain TabUse a custom domain to host your Portal from a domain fully under your control. Custom domains are available on the Enterprise Plan. Once configured, you…
- Configure Subdomains for Portal On-PremPortal On-Prem supports configuring a predefined list of allowed portal subdomains. This feature is useful in environments where wildcard DNS entries are…
- Products Settings PageUse this page to:
- Top MenuUse the top menu to:
- Side Navigation PanelUse this page to:
- General TabUse the General tab to manage or delete the active product.
- Product Content PageUse this page to:
- Navigation PanelUse the side navigation panel to:
- Main ScreenUse this page to:
- Notification CenterThe table below shows icons that might appear when you edit a page or API in your portal. This summary provides an overview of these icons to help you…
- Manage APIsYou can only view, link, and unlink APIs in Portal.
- Manage DocumentationTo create a new page:
- Create Pages with AISwagger Portal AI allows you to create, edit, or enhance your Portal pages by describing them in natural language. You can use AI-powered features to…
- Manage ProductsTo create a new product:
- Manage Access RequestsThe Access Requests page in Swagger Portal allows Consumers to request access to products and organization owners to grant or deny access to a product.…
- PreviewYou can preview your changes in your portal before you publish them. The Portal offers the following preview modes based on your location within it:
- Product TemplatesUse a product template to streamline creating new products and maintain consistency across documentation.
Consumer View
Automation
Integrations
FAQ
Technical Support
Glossary
Appendix
- AppendixThis page contains additional information that complements the main content of Portal the documentation.
- Routing RequestsRead more about routing requests and CORS requirements in the following sections:
- Routing API Requests for "Try It Out"Portal lets you send "try it out" requests directly from your browser to the target server or proxy the requests through the Portal server. As a rule of…
- CORS Requirements for "Try It Out"Cross-origin resource sharing (CORS) is a security mechanism that allows a web page from one domain to access resources from another domain.
- IP AddressesSince October 2, 2021, Swagger Studio uses these IP addresses: