Comment créer un APi en C #?
Je fais de la programmation, mais maintenant je fais face à un défi. Je suis sur un projet où je dois créer une API en C # pour mes utilisateurs. Le processus de base est que j'ai un code C # où je lis un fichier XML et j'obtiens les attributs et les valeurs qui se trouvent entre les balises. J'ai réussi et maintenant je dois créer une API consommable pour la même fonctionnalité. Existe-t-il un moyen par lequel je peux apprendre à créer une API?
Fondamentalement, je n'ai aucune idée de la façon de passer à l'API. Toute sorte d'exemples me serait d'une grande utilité.
Une API n'est qu'un moyen pour d'autres programmeurs de s'interfacer avec votre code. La bibliothèque de classes AC # peut être une API, tout comme un service Web, un point de terminaison WCF, etc. que vous pouvez distribuer.
Comme mentionné par d'autres, les directives de conception du cadre sont utiles pour certaines règles à suivre.
Une chose à garder à l'esprit - et je souhaite que cela soit appliqué à tous les nouveaux développeurs de logiciels - est que la conception des API est fondamentalement un problème d'utilisation. Vous créez une interface utilisateur pour les utilisateurs de votre logiciel et vos utilisateurs sont d'autres programmeurs.
Cela signifie que vous souhaitez suivre tous les principes généraux de la conception UI/UX - découverte, simplification des tâches courantes, etc.
Profitez des commentaires XML pour vous assurer que la documentation est toujours là. Assurez-vous que les tâches les plus courantes sont faciles à effectuer et qu'il est évident de le faire. Nettoyez les exceptions et incluez des messages d'erreur utiles et exploitables. Pensez à ce qui faciliterait la vie du consommateur.
Faire une API en C # n'est pas un gros problème, mais faire une bonne API est tout un défi.
Si vous souhaitez distribuer votre assembly en tant qu'API, il vous suffit d'ajouter un Projet de bibliothèque de classes dans votre Visual Studio.
Ou si vous souhaitez exposer votre API en tant que service, vous pouvez envisager WCF et Web Api .
Pour faire une bonne et efficace API, vous devez étudier Framework Design Guidlines
Votre question est peu générale ..
Cependant j'essaye de vous répondre. Voyez si vous voulez créer une API qui peut être appelée via HTTP, vous pouvez le faire en utilisant WCF.
Vous pouvez lire sur WCF sur wcftutorial.net
Vous pouvez créer une API en utilisant DLL également et je vous recommande de lire http://www.c-sharpcorner.com/UploadFile/mahesh/dll12222005064058AM/dll.aspx =
pour un démarrage rapide sur la façon de créer un DLL à l'aide de Visual C #.
Merci,
Si vous souhaitez créer une API facilement utilisable, cela peut être un défi.
Tout d'abord: pensez aux interfaces. Écrivez des interfaces qui peuvent être utilisées par ceux qui ont besoin des fonctionnalités que vous fournissez.
Et: restez simple!
Au mieux, vous écrivez deux projets lors du développement de votre API.
- L'API qui sera utilisée par vos utilisateurs
- Un exemple de projet/projet de test qui utilise déjà votre API.
De cette façon, vous vous retrouverez avec une API complète et quelques exemples qui montrent comment vous pensez que votre API devrait être utilisée, valant plus que toute documentation, comme un exemple simple en dit plus qu'une description. (bien sûr, vous devez toujours décrire ce que votre API peut faire)
Fournissez des classes dans votre API qui peuvent être utilisées telles quelles, c'est-à-dire que les utilisateurs de votre API ne doivent pas fournir ce que vous pouvez faire à l'intérieur de votre API.
S'amuser!
Si vous voulez avoir une compréhension de base de ce qui est important, je peux recommander ce livre sur les directives de conception du cadre . C'est assez intéressant à lire même si vous ne prévoyez pas de concevoir votre propre cadre, et cela donne un bon aperçu des raisons pour lesquelles certaines décisions doivent être prises et d'autres non.