Come iniziare a creare un'applicazione API in .NET

Question

Nella società in cui lavoro abbiamo un'applicazione desktop sviluppata in .NET che ci piace aprire alcune parti per altri sviluppatori di software.

Lo vedo come una sorta di metodo pubblico a cui altri software possono accedere. Esiste un approccio standard, le migliori pratiche o altre esperienze al riguardo?

Credo che si possa fare questo con chiamate Win32, programmazione C/C++ ecc. Ma io sono principalmente uno sviluppatore .NET e ho alcuni anni di esperienza nella programmazione principalmente in VB.NET ma anche in C#. Spero di trovare un modo per farlo in .NET. Ma dovrebbe essere accessibile per software sviluppato in altre lingue.

migliori saluti/ Magnus

Answer 1

Ci sono due modi per farlo. Il primo riguarda l'utilizzo del pattern Plug In/Module. Start here per quello.

Un altro modo è di esporre semplicemente la logica dell'API attraverso assembly ben documentati.

Il modo in cui scegli si riduce a come desideri implementarlo. Ad esempio, Adobe Photoshop utilizza il pattern plug-in in larga misura. MS Office utilizza entrambi i plug-in e fornisce un'interfaccia a oggetti per lavorare con l'applicazione.

UPDATE: oggetti negli assiemi NET possono essere esposti ad essere consumati da applicazioni esterne semplicemente modificando la portata oggetti pubblica. Ciò include i moduli di Windows, gli oggetti business, enum, ecc.

Basti pensare dal punto di vista dello sviluppatore esterno. Di quali informazioni avranno bisogno per avere successo nell'estensione/controllo del prodotto? Qualunque cosa sia, mettila nel file di aiuto.

Inoltre, utilizzare le funzionalità di autocomposizione di .Net. Ciò include l'aggiunta della documentazione xml che l'IDE già sa leggere e visualizzare tramite intellisense. Ad esempio:

/// <summary> 
/// Gets all active documents for the specified customer. 
/// </summary> 
/// <param name="customerId">The Id of the customer.</param> 
/// <returns>A list of documents for this customer.</returns> 
public static List<Document> GetDocuments(int customerId) 
{ 
    //... do something ... 
} 

Answer 2

Lo sviluppo di un'API pubblica dipende in gran parte la funzionalità del programma. Se si desidera esporre un'API accessibile ad altre lingue, i servizi Web XML sono generalmente il modo per farlo. Tuttavia, ciò potrebbe non essere pratico per un'applicazione desktop-only.

Answer 3

"Esporre l'applicazione tramite un'API pubblica" non è una definizione dettagliata dei requisiti. Prima di progettare qualsiasi cosa, ottenere i requisiti dettagliati.

Per un'API, si consiglia di iniziare con i requisiti, quindi procedere con l'utilizzo dei casi. Poiché si tratta di un'API, dovresti effettivamente scrivere del codice utilizzando l'API proposta, per vedere come ci si sente a programmarlo. Il codice che scrivi dovrebbe riguardare i casi d'uso con cui inizi. Potresti persino scrivere quel codice nei test unitari, quindi creare l'API attraverso lo sviluppo e il refactoring basati sui test.

Tuttavia, poiché i casi di utilizzo si concentrano su come l'utente utilizzerà il software, ti aiuteranno a concentrarti su quali parti del software l'utente utilizza direttamente. Un caso d'uso può usarne un altro; ma se un utente non utilizza direttamente un particolare caso d'uso, allora questo non deve essere esposto pubblicamente.

Nota che questo mi ha aiutato anche nello sviluppo dei servizi web.I casi d'uso direttamente accessibili dall'utente diventano le operazioni da esporre attraverso il servizio. Qualsiasi caso d'uso che l'utente non invochi direttamente rimarrà nascosto, come implementazione.

Answer 4

creare una classe API che espone ciò funzioni che si desidera persone di avere accesso e registrarlo per il progetto COM Interop -> Proprietà -> Crea -> Registra per interoperabilità COM