Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Make API swagger-compliant

Aperta
#2 0 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
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
javascript, node.js, ruby
Ambito
api, documentation

Direzione di ricerca

Inizia con l’API Ruby attuale e il relativo README, quindi esamina grape-swagger e i progetti collegati swagger-codegen e swagger-js. Il lavoro è completato quando l’API è conforme a Swagger e la documentazione dinamica sostituisce il README; l’issue non specifica file né test, quindi occorre innanzitutto individuare i punti di ingresso dell’implementazione.

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

Descrizione

And generate some awesome dynamic docs instead of the ghetto README.
https://github.com/ruby-grape/grape-swagger

Investigate code generation stuff, and the JS library for nodejs:
https://github.com/swagger-api/swagger-codegen/tree/master#where-is-javascript
https://github.com/swagger-api/swagger-js

cc: @dougestey

Lingua principale
Ruby
Stelle
2
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 CivicTechTO/tocityhall-api

Tutte le issue di CivicTechTO/tocityhall-api

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.