[Request] Auto-generated, publicly accessible API docs

Aperta
#838 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
api, documentation

Direzione di ricerca

Inizia esaminando il gist di documentazione API esistente collegato nell'issue, quindi fai un inventario degli endpoint attuali per il recupero e la creazione dei dati e per l'invio di comandi. Definisci la posizione pubblica della documentazione generata e verifica che copra questi gruppi di endpoint per gli sviluppatori di Farmware e delle integrazioni.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Currently https://gist.github.com/RickCarlino/10db2df375d717e9efdd3c2d9d8932af exists but it would be very useful to have a, for example, https://api.farm.bot that detailed the available endpoints for data retrieval, creation, and issuing commands would be very useful for farmware and integration developers.

If something like this already exists please point me to it and close this ticket.

Lingua principale
TypeScript
Stelle
978
Fork
357
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di FarmBot/Farmbot-Web-App

Tutte le issue di FarmBot/Farmbot-Web-App

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.