CLI, REST API und CI/CD-Plugins — alles, was du brauchst, um APIs automatisiert zu deployen, zu validieren und zu verwalten.
$ apiportal deploy --env production
✓ Uploading OpenAPI spec... done
✓ Validating schema... passed (0 errors)
✓ Generating documentation... done
✓ Running linter checks... passed
✓ Publishing to portal... done
✓ Deployed successfully!
→ https://app.api-portal.io/docs/payment-api/v3
$
Dein Toolkit auf einen Blick
// CLI
// CLI Tool
Das API Portal CLI ist dein zentrales Werkzeug für die Verwaltung von APIs direkt aus dem Terminal. Login, Upload, Validierung und Environment-Management — alles in einem Befehl.
$ apiportal login
✓ Authenticated as jan@netscale.io
$ apiportal push --file openapi.yaml
✓ Uploading openapi.yaml... done
✓ Version v2.4.0 created
$ apiportal validate openapi.yaml
✓ Schema valid (0 errors, 0 warnings)
$ apiportal environments list
production ● active v2.4.0
staging ● active v2.5.0-beta
development ● idle v2.5.0-dev
$
// REST API
GET /api/management/v1/capabilities
Authorization: Bearer eyJhbGci...kpXVCJ9
X-Tenant-ID: tenant-netscale-prod
// Response 200 OK
{
"data": [
{
"id": "cap_payment_api",
"name": "Payment API",
"version": "3.1.0",
"status": "published"
}
],
"cursor": "eyJpZCI6MTB9"
}
// REST API
Die vollständige Management API basiert auf OpenAPI 3.1.0 und bietet dir programmatischen Zugriff auf alle Funktionen des API Portals.
// CI/CD
Integriere API Portal nahtlos in deine bestehende Pipeline — mit nativen Plugins für die beliebtesten Plattformen.
# .github/workflows/deploy.yml
name: Deploy API Spec
on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: apiportal/deploy@v1
with:
file: openapi.yaml
env: production
# .gitlab-ci.yml
stages:
- deploy
deploy_api:
stage: deploy
image: apiportal/cli:latest
script:
- apiportal login --token $PAT
- apiportal push --file openapi.yaml
- apiportal deploy --env production
only:
- main
// Jenkinsfile
pipeline {
agent any
stages {
stage('Deploy API') {
steps {
sh '''
apiportal login \
--token $PAT
apiportal deploy \
--file openapi.yaml \
--env production
'''
}
}
}
}
// Authentifizierung
// PAT
Personal Access Tokens ermöglichen eine sichere, granulare Authentifizierung für CLI und API. Verwalte Berechtigungen, setze Ablaufdaten und widerrufe Tokens jederzeit.
| Name | Scopes | Ablaufdatum | |
|---|---|---|---|
| CI/CD Pipeline | read write | 2026-06-15 | Widerrufen |
| Local Dev | read | 2026-04-01 | Widerrufen |
| Admin Tools | read write admin | 2026-12-31 | Widerrufen |
“Seit wir die CI/CD-Integration von API Portal nutzen, haben sich unsere manuellen Deployments um 90% reduziert. Das CLI ist intuitiv und die REST API lässt keine Wünsche offen.”
// Weitere Features
Starte jetzt mit CLI, REST API und CI/CD-Integration — und bringe deine API-Workflows auf das nächste Level.