Everything you need to start generating beautiful API documentation with AI assistance.
Install API Concierge using npm, pip, or download the standalone binary:
# Via NPM (Node.js)
npm install -g apiconcierge
# Via pip (Python)
pip install apiconcierge
# Via Homebrew (macOS)
brew install apiconcierge
# Or download binary
# Visit: github.com/apiconcierge/releases
Requirements: Node.js 16+ or Python 3.8+
Point API Concierge to your OpenAPI specification:
# From local file
apiconcierge import ./openapi.yaml
# From URL
apiconcierge import https://api.example.com/spec
# From Postman collection
apiconcierge import ./collection.json --format postman
# Scan SDK directory
apiconcierge scan ./sdk/ --language python
Supported formats: OpenAPI 3.0/3.1, Swagger 2.0, Postman, RAML
Create interactive documentation with code examples:
# Generate docs with default settings
apiconcierge generate
# Specify output languages
apiconcierge generate --languages python,javascript,go,curl
# Custom output directory
apiconcierge generate --output ./docs
# Generate with live preview
apiconcierge generate --serve
✨ Your docs will be ready at ./docs/index.html
Deploy your documentation to various platforms:
# Deploy to API Concierge hosting
apiconcierge deploy
# Export as static HTML
apiconcierge export --format html
# Export as Markdown
apiconcierge export --format markdown
# Integrate with CI/CD
apiconcierge ci-setup --platform github-actions
🚀 Your docs are now live and accessible!
Customize API Concierge behavior with a configuration file in your project root:
{
"api": {
"spec": "./openapi.yaml",
"baseUrl": "https://api.example.com"
},
"output": {
"directory": "./docs",
"format": "html",
"theme": "dark"
},
"generation": {
"languages": ["python", "javascript", "go", "curl"],
"includeExamples": true,
"includeErrorHandling": true,
"includeRetryLogic": true
},
"ai": {
"errorDetection": true,
"bestPractices": true,
"securityChecks": true
},
"server": {
"port": 3000,
"liveReload": true
}
}
apiconcierge import <source>
--format <openapi|swagger|postman|raml>
--validate
--output <file>
apiconcierge scan <directory>
--language <python|js|go|java>
--recursive
apiconcierge generate
--languages <list>
--output <dir>
--theme <dark|light>
--serve
--watch
--port <number>
apiconcierge analyze
--security
--performance
--consistency
apiconcierge validate
--strict
--report <file>
apiconcierge deploy
--platform <hosting|netlify|vercel>
apiconcierge export
--format <html|markdown|pdf>
apiconcierge ci-setup
--platform <github|gitlab|jenkins>
Automatically generate and deploy docs on every push:
name: Generate API Docs
on:
push:
branches: [main]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install API Concierge
run: npm install -g apiconcierge
- name: Generate docs
run: |
apiconcierge import ./openapi.yaml
apiconcierge generate --output ./docs
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs
Use API Concierge programmatically in your application:
const { APIConcierge } = require('apiconcierge');
const concierge = new APIConcierge({
spec: './openapi.yaml',
languages: ['python', 'javascript', 'curl']
});
// Generate documentation
await concierge.generate({
output: './docs',
theme: 'dark'
});
// Analyze API
const analysis = await concierge.analyze({
security: true,
performance: true
});
console.log('Security issues:', analysis.security);
console.log('Performance tips:', analysis.performance);
Integrate API Concierge into your CI/CD pipeline to automatically regenerate docs whenever your API spec changes.
Never commit API keys to version control. Use environment variables or secure secret management systems.
Always run `apiconcierge validate` before deploying to catch spec errors and inconsistencies early.
Use custom CSS to match your brand. API Concierge generates clean HTML that's easy to style.
Enable analytics to understand which endpoints developers use most and where they struggle.
Add feedback mechanisms to your docs. API Concierge can help identify common issues from user reports.
Yes! API Concierge is open-source and free for both personal and commercial use. Premium hosting and enterprise support are available.
OpenAPI 3.0/3.1, Swagger 2.0, Postman Collections, RAML, API Blueprint, and common SDK documentation formats.
Absolutely! You can customize themes, add custom CSS, modify templates, and even inject custom HTML sections.
Yes! Generated documentation is fully static HTML that works offline. The CLI tool also works without internet once installed.
API Concierge analyzes common patterns, authentication flows, and response structures to identify potential integration issues and suggest fixes.
Yes! API Concierge is open-source. Visit our GitHub repository to contribute code, report issues, or suggest features.
Install API Concierge now and transform your API documentation workflow.
npm install -g apiconcierge
apiconcierge import ./openapi.yaml
apiconcierge generate --serve