Sviluppo dell'API JSON per un motore Carpool

Question

Sviluppo dell'API JSON per un motore Carpool

#1 da (1 voti)
#2 da (1 voti)

3

Sto sviluppando una nuova serie di metodi API per la prenotazione di carpooling / taxi, quindi se uno sviluppatore deve sviluppare un'app o un portale web per il carpooling, può chiamare la mia API JSON. Fondamentalmente è facile per gli sviluppatori.

La mia corrente API ha:

AddVehicle
AddJourney
SearchJourney
SubscribeToThisJourney(journey)
SubscriberList(journey) per ottenere l'elenco delle persone che si sono abbonate per questo viaggio
AcceptSubscription(subscriber)
AcceptedSubcriberList
SubscriberList per ottenere l'elenco dei fornitori che ho sottoscritto a

Ho bisogno di aiuto per sostituire l'abbonato con qualcos'altro. È difficile da ricordare e confonde quando vedi 3 metodi che significano cose molto diverse: SubscriberList , SubscribedToThisJourneyList e AcceptedSubscriberList . Confondere per ricordare.

Uno è un elenco di chi ho sottoscritto
Chi mi ha iscritto
Per la sottoscrizione che ho accettato

Come posso denominare questi metodi per renderli più facili da comprendere e ricordare?

interfaces api

posta Siddharth 01.11.2012 - 15:02

fonte

2 risposte

1

Non vedo alcun problema con i nomi scelti, poiché il verbo subscribe e il nome subscriber hanno significati molto diversi (ma giustamente) correlati in inglese.

La corretta documentazione sarà la chiave qui.

risposta data 01.11.2012 - 17:49

fonte

Leggi altre domande sui tag interfaces api

Gestione di bug, stranezze o fastidi nelle intestazioni fornite dal fornitore Modi per raccogliere informazioni sugli eventi da Internet [chiuso]

score 1 · Accepted Answer

Ecco alcuni suggerimenti per i nomi dei tre metodi elencati come che richiedono attenzione:

Uno è un elenco di chi ho sottoscritto a - in base alla tua descrizione precedente per SubscriberList , suppongo per "chi" intendi quali provider, quindi una versione più chiara potrebbe essere: ProvidersSubscribedTo(user)
Chi mi ha sottoscritto - supponendo che questo sia inteso per elencare gli abbonati che io, come fornitore, non ho ancora accettato: PendingSubscribers(provider)
Per la sottoscrizione che ho accettato - AcceptedSubscribers(provider)

Ho usato i parametri per indicare il contesto della chiamata al metodo, quindi a seconda di come vengono effettuate le chiamate, potrebbero non essere richiesti.