TechDocs

Willkommen bei TechDocs!

Diese Anwendung bietet ein robustes System zur Erstellung, Verwaltung und Bereitstellung von IT-Dokumentationen und Cheat Sheets. Die API-Endpunkte sind unten aufgelistet.

Das System verwendet Markdown für die Dokumentation, was eine einfache Formatierung und Pflege ermöglicht.

API-Endpunkte

Dokumentation

• GET /api/docs
  Alle Dokumente abrufen
• GET /api/docs/:id
  Einzelnes Dokument abrufen
• GET /api/docs/slug/:slug
  Dokument per Slug abrufen
• POST /api/docs
  Neues Dokument erstellen
• POST /api/docs/import
  Markdown-Datei importieren
• PUT /api/docs/:id
  Dokument aktualisieren
• DELETE /api/docs/:id
  Dokument löschen

Kategorien

• GET /api/categories
  Alle Kategorien abrufen
• GET /api/categories/:id
  Einzelne Kategorie abrufen
• GET /api/categories/slug/:slug
  Kategorie per Slug abrufen
• POST /api/categories
  Neue Kategorie erstellen
• PUT /api/categories/:id
  Kategorie aktualisieren
• DELETE /api/categories/:id
  Kategorie löschen

Suche

• GET /api/search?q=suchbegriff
  Dokumente durchsuchen

Authentifizierung

• POST /api/auth/register
  Neuen Benutzer registrieren
• POST /api/auth/login
  Benutzer anmelden
• GET /api/auth/me
  Aktuellen Benutzer abrufen
• GET /api/auth/logout
  Benutzer abmelden

Erste Schritte

Um mit TechDocs zu beginnen, sollten Sie zuerst einen Benutzer registrieren und dann Kategorien und Dokumente erstellen.

Die API kann über jeden HTTP-Client wie curl, Postman oder programmatisch über Ihre Anwendung angesprochen werden.