Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.DS_Store
portal/
portal/
CLAUDE.md
14 changes: 7 additions & 7 deletions src/APIMATIC-BUILD.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@
"faviconUrl": "static/images/favicon.ico",
"languageConfig": {
"java": {
"packageRepository": "Maven",
"packageSettings": {
"GroupId": "com.apimatic",
"PackageName": "sample-sdk-artifact-id",
"Version": "1.0.0"
}
"packageRepository": "Maven",
"packageSettings": {
"GroupId": "com.apimatic",
"PackageName": "sample-sdk-artifact-id",
"Version": "1.0.0"
}
},
"typescript": {},
"ruby": {},
Expand All @@ -32,7 +32,7 @@
"theme": {
"baseTheme": "cosmos",
"colorMode": {
"defaultMode": "system",
"defaultMode": "light",
"disableSwitch": false
},
"colors": {
Expand Down
12 changes: 6 additions & 6 deletions src/content/toc.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
toc:
- group: Onboarding Guides
icon: book-open-text
items:
- page: Overview
file: guides/overview.md
# The Endpoint and Models sections contain auto-generated content. The 'generate' and 'from' directives instruct APIMatic's Docs generation service
# to generate and insert these sections here.
- group: Getting Started
icon: clock-fading
items:
# 'generate' specifies that this item will be auto-generated by APIMatic. A file/directory reference is not needed here
- generate: SDK Quickstart
- generate: Quickstart
from: getting-started
- generate: API Endpoints
icon: braces
Expand All @@ -28,3 +23,8 @@ toc:
- generate: SDK Infrastructure
icon: life-buoy
from: sdk-infra
- group: Why APIMatic
icon: badge-check
items:
- page: What APIMatic Offers
file: why-apimatic/what-apimatic-offers.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,41 @@
## Your API Developer Portal Overview
## What APIMatic Offers

### What You Just Created
This developer portal is powered by **APIMatic**. The same platform that generated this experience can turn any OpenAPI specification into a complete developer portal — interactive documentation, auto-generated SDKs in multiple languages, live API testing, and AI-assisted onboarding — in minutes.

You've generated a comprehensive API developer portal that transforms your OpenAPI specification into a complete developer experience. This includes interactive documentation, auto-generated SDKs in multiple languages, live API testing capabilities, and AI-accessible documentation.

### Core Capabilities
### What You Get with APIMatic

<CardGroup cols={2}>
<Card title="AI-Ready API Context" icon="Sparkles">
Context Plugins load your full API context — docs, SDKs, code samples, and setup instructions — into AI coding environments like Claude Code and Cursor, so developers integrate your API through natural language instead of a wall of reference docs. A built-in portal copilot is available too.
</Card>
<Card title="SDK & API Documentation" icon="BookOpenText">
API Reference documentation with language‑specific docs and SDK guides. Developers can explore your API structure before writing any code.
API Reference documentation with language‑specific docs and SDK guides — including idiomatic, ready-to-run code samples complete with imports across all seven SDK languages. Developers can explore your API structure before writing any code.
</Card>
<Card title="Live API Playground" icon="ArrowBigUpDash">
Built-in testing interface supporting all major authentication methods. Developers can make real API calls, see actual responses, and validate their integration approach.
</Card>
<Card title="Multi-Language SDKs" icon="FileBox">
Production-ready client libraries in Java, Python, TypeScript, C#, PHP, Ruby, and Go. Each SDK includes comprehensive documentation, code samples, and follows language-specific best practices.
</Card>
<Card title="API Recipes" icon="Palette">
<Card title="API Recipes" icon="ChefHat">
Step-by-step onboarding flows to help developers implement key API usecases faster.
</Card>
<Card title="Brand Customization" icon="Palette">
Full control over colors, fonts, logos, and layout. Add custom documentation pages, modify navigation, and ensure the portal reflects your brand identity.
</Card>
<Card title="AI Integration Ready" icon="TextSearch">
Automatic generation of llms.txt files makes your API discoverable by AI coding assistants. Built-in API copilot answers developer questions using your documentation.
</Card>
</CardGroup>


### Next Steps
### Ready to Build Your Own?

In the next 15 minutes you can add custom guides, create API recipes, apply your branding, enable AI assistance, and optimize for discoverability.
Bring your API to APIMatic and ship a developer portal like this one in minutes.

<CardGroup cols={2}>
<Card title="Ready to see what's possible?" url="https://docs.apimatic.io/cli-getting-started/advanced-portal-setup/">
Explore the Advanced Features Guide and unlock your portal's full potential.
<Card title="Explore APIMatic" url="https://www.apimatic.io/">
See how APIMatic turns your API specification into a branded, AI-ready developer portal.
</Card>
<Card title="Read the Docs" url="https://docs.apimatic.io/cli-getting-started/advanced-portal-setup/">
Dive into the Advanced Features Guide to set up and customize your own portal.
</Card>
</CardGroup>

Expand All @@ -51,15 +52,19 @@ APIMatic automatically updates your portal when your API specification changes.
</Accordion>

<Accordion title="What level of customization and control do we have?">
You can completely customize the look, feel and behavior of your Developer Experience Portal, including primary colors, themes, custom sections, navigation links, and branding. You can also choose to host it on your own custom domain or embed it seamlessly into your existing documentation site using a simple HTML script.
You can completely customize the look, feel and behavior of your Developer Experience Portal, including primary colors, themes, custom sections, navigation links, custom URL slugs, and branding. You can also choose to host it on your own custom domain or embed it seamlessly into your existing documentation site using a simple HTML script.
</Accordion>

<Accordion title="Is there a way we can integrate this with our existing Developer Portal?">
Absolutely. APIMatic provides embeddable portal components that can be seamlessly integrated into your existing documentation sites using a simple HTML script. You can also choose to host the portal separately on your own domain while maintaining your existing portal structure.
</Accordion>

<Accordion title="What AI capabilities does this Developer Portal have?">
APIMatic's Developer Portal includes two key AI features: an API copilot that can answer questions about your API based on information from the API reference documentation and product documentation, and automatic LLMs.txt file generation that makes your documentation AI-accessible to tools like Cursor, GitHub Copilot, ChatGPT, and Claude.
**Context Plugins** let developers connect your API to the AI coding assistant they already use (Cursor, GitHub Copilot, Claude, and more) to search, ask questions, and generate working integration code grounded in your live specification.

The portal also includes a built-in **API Copilot** that answers questions from your API reference and product documentation, and an **AI Assist Menu** that sends any documentation page straight to your preferred AI tool as context with one click.

Automatic **LLMs.txt generation** and per-page Markdown exports make your documentation AI-accessible to tools like Cursor, GitHub Copilot, ChatGPT, and Claude.
</Accordion>

</AccordionGroup>
</AccordionGroup>
Loading