Skip to content
Merged
Changes from 4 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
02cdcdf
[TT-15909] Docs update for Graphql Playground.mdx
JoanCamosTyk Nov 4, 2025
59317ad
Update api-products.mdx
JoanCamosTyk Nov 5, 2025
f046566
Update api-products.mdx
JoanCamosTyk Nov 5, 2025
6b541f7
Update api-products.mdx
JoanCamosTyk Nov 5, 2025
125326f
Update portal/api-products.mdx
sharadregoti Nov 6, 2025
09d74d9
Update portal/api-products.mdx
sharadregoti Nov 6, 2025
989a795
Merge main into JoanCamosTyk-patch-2
buger Nov 6, 2025
df7f2ea
Merge main into JoanCamosTyk-patch-2
buger Nov 7, 2025
731b141
Update api-products.mdx
JoanCamosTyk Nov 10, 2025
1593d33
Add files via upload
JoanCamosTyk Nov 10, 2025
9b24a12
Delete img/portal/portal-graphql-playground.png
JoanCamosTyk Nov 10, 2025
242ae9d
Add files via upload
JoanCamosTyk Nov 10, 2025
2b03f8f
Update api-products.mdx
JoanCamosTyk Nov 10, 2025
6fc9e61
Update api-products.mdx
JoanCamosTyk Nov 10, 2025
1c03531
Merge main into JoanCamosTyk-patch-2
buger Nov 11, 2025
b2bc321
Merge main into JoanCamosTyk-patch-2
buger Nov 11, 2025
208c778
Merge main into JoanCamosTyk-patch-2
buger Nov 11, 2025
9ffac03
Merge main into JoanCamosTyk-patch-2
buger Nov 11, 2025
cabbb48
Merge main into JoanCamosTyk-patch-2
buger Nov 11, 2025
c5ac221
Merge main into JoanCamosTyk-patch-2
buger Nov 11, 2025
6c56b60
Merge main into JoanCamosTyk-patch-2
buger Nov 11, 2025
4007117
Merge main into JoanCamosTyk-patch-2
buger Nov 12, 2025
0eb23cd
Delete img/portal/Portal-graphql-playground.png
JoanCamosTyk Nov 12, 2025
1b0e7d9
Add files via upload
JoanCamosTyk Nov 12, 2025
5bf0425
Update api-products.mdx
JoanCamosTyk Nov 12, 2025
bd31227
Update api-products.mdx
JoanCamosTyk Nov 12, 2025
dd6a6da
Update api-products.mdx
caroltyk Nov 12, 2025
b89647b
Update publish-api-catalog.mdx
JoanCamosTyk Nov 13, 2025
997ab14
Update request-access.mdx
JoanCamosTyk Nov 13, 2025
0162e77
Apply suggestion from @caroltyk
caroltyk Nov 13, 2025
c5e43d4
Merge main into JoanCamosTyk-patch-2
buger Nov 14, 2025
4c7a332
Merge main into JoanCamosTyk-patch-2
buger Nov 14, 2025
65d1c70
Merge main into JoanCamosTyk-patch-2
buger Nov 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 33 additions & 4 deletions portal/api-products.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,28 @@ Your new API Product will now be available on the **API Products** page. You wil

These are the minimal steps to create an API Product and of course it won't be very appealling to API Consumers if you did publish it. You might want to select the Product's tile and add some description, documentation and user guides. Remember to select **Save Changes** when you are done.

## GraphQL Playground in the Developer Portal
### Overview
The Tyk Enterprise Developer Portal now supports a fully integrated GraphQL Playground, allowing developers to explore and test GraphQL queries directly within the portal interface.
This playground provides a powerful, interactive experience for working with GraphQL APIs.

Note: This feature is available from Portal version 1.15.0 and above.

### What is the GraphQL Playground?
The GraphQL Playground is a developer tool embedded in the Enterprise Developer Portal. It enables developers to:
- Browse the API’s schema and documentation
- Test queries and mutations
- Explore available types and fields
- Download the GraphQL schema

This helps improve the onboarding experience and allows for easier validation and experimentation with your APIs.

### When is it Available?
The GraphQL Playground will automatically be available for an API in the Developer Portal if:
- The API is marked as GraphQL
- A valid GraphQL schema file (SDL) has been uploaded during product creation or update
Once enabled, developers will see the GraphQL Playground in the API Explorer tab of a GraphQL API Product.

## API Product Reference Guide

This comprehensive reference guide details all the configurable options and features of API Products in the Tyk Developer Portal.
Expand Down Expand Up @@ -167,7 +189,9 @@ Detailed technical documentation generated from OpenAPI specifications.

- **Location**: *API Products > Add/Edit API Product > Documentation tab > Add API specification*
- **Purpose**: Provides detailed technical reference documentation
- **Format**: Upload OpenAPI Description files in JSON or YAML format from file or URL
- **Format**: Upload API specification files in multiple formats:
- OpenAPI: JSON or YAML format from file or URL
- GraphQL SDL: Schema Definition Language files (.graphql, .graphqls, or JSON format) from file or URL
- **Display**: Rendered as interactive documentation in the Live Portal
- **Size Limit**: Configured using the `PORTAL_MAX_UPLOAD_SIZE` configuration (to a maximum of 32MB)
- **Note**: For a [Documentation-only Product](/portal/api-products#documentation-only-products) the *Specification Alias* will be used as the reference for each OpenAPI document, rather than the API name
Expand Down Expand Up @@ -270,7 +294,9 @@ To create a Documentation-only Product:

1. Create a new API Product following the standard process
2. On the **APIs** tab, do not select any APIs from the [list](/portal/api-products#api-list)
3. On the **Documentation** tab, add [OpenAPI documentation](/portal/api-products#api-reference-documentation) as needed
3. On the **Documentation** tab, add API documentation as needed:
- [OpenAPI documentation](/portal/api-products#api-reference-documentation): Upload OpenAPI Description files in JSON or YAML format.
- [GraphQL SDL](/portal/api-products#api-reference-documentation): Upload GraphQL Schema Definition Language (SDL) files (.graphql, .graphqls, or JSON format)
4. Configure the usual Product descriptions, imagery and and [usage guides](/portal/api-products#getting-started-guide) you wish to display in the Live Portal
5. Publish the Product to your desired Catalog(s)

Expand All @@ -289,8 +315,11 @@ The Product will appear in Catalogs like any other Product
- Consider using a consistent naming convention (e.g., "[DOCS] Payment Integration Guide")
- If documenting a future API, include expected release timeframes
- For educational resources, structure content in a logical learning sequence
- Format Selection: Choose the appropriate documentation format:
- Use OpenAPI for REST APIs with detailed endpoint documentation
- Use GraphQL SDL for GraphQL APIs to showcase schema structure and available operations

Documentation-only Products provide flexibility in how you communicate with your developer community, allowing you to share valuable information even when API access isn't available or necessary.
Documentation-only Products provide flexibility in how you communicate with your developer community, allowing you to share valuable information for both REST and GraphQL APIs even when API access isn't available or necessary.

## API Product Best Practices

Expand Down Expand Up @@ -345,4 +374,4 @@ Documentation-only Products provide flexibility in how you communicate with your
#### Product Not Visible in Catalog

- Confirm the Product is assigned to the Catalog
- Verify Catalog visibility settings
- Verify Catalog visibility settings