私はプログラミングをしてきましたが、今は課題に直面しています。私は、ユーザーのためにC#でAPIを作成する必要があるプロジェクトに取り組んでいます。基本的なプロセスは、XMLファイルを読み取ってタグの間にある属性と値を取得するC#コードを持っていることです。私はそれを達成しました、そして今私は同じ機能のために消耗品のAPIを作成しなければなりません。APIの作成方法を学ぶ方法はありますか?
基本的に、APIをどのように進めるかについてはわかりません。どんな種類の例も私には役立つでしょう。
APIは、他のプログラマーがコードとインターフェイスするための単なる方法です。AC#クラスライブラリは、WebサービスやWCFエンドポイントなどと同様にAPIにすることができます。これを作成する最も簡単な方法は、C#クラスライブラリプロジェクトを作成し、パブリックメソッドがあることを確認して、.dllにコンパイルすることです。配布できます。
他の人が述べているように、フレームワーク設計ガイドラインは、従うべきいくつかのルールに役立ちます。
覚えておくべきことの1つは、API設計が基本的にユーザビリティの問題であるということです。これが、すべての新しいソフトウェア開発者に浸透することを願っています。あなたはあなたのソフトウェアのユーザーのためのUIを構築していて、あなたのユーザーは他のプログラマーです。
これは、UI / UXデザインのすべての一般的な原則(発見可能性、一般的なタスクの簡素化など)に従う必要があることを意味します。
XMLコメントを利用して、ドキュメントが常にそこにあることを確認してください。最も一般的なタスクは実行が簡単であり、その方法が明らかであることを確認してください。例外をクリーンにし、有用で実用的なエラーメッセージを含めます。消費者の生活を楽にするものを考えてください。
C#でAPIを作成することは大したことではありませんが、優れたAPIを作成することは非常に困難です。
アセンブリをAPIとして配布する場合は、VisualStudioにクラスライブラリプロジェクトを追加するだけです。
または、APIをサービスとして公開する場合は、WCFとWebApiを検討してください。
優れた効率的なAPIを作成するには、フレームワーク設計ガイドラインを学習する必要があります
あなたの質問は少し一般的です。
しかし、私はあなたに答えようとします。HTTP経由で呼び出すことができるAPIを作成するかどうかを確認し、WCFを使用してこれを行うことができます。
あなたはwcftutorial.netでWCFについて読むことができます
DLLを使用してAPIを作成することもできます。http: //www.c-sharpcorner.com/UploadFile/mahesh/dll12222005064058AM/dll.aspxを読むことをお勧めします 。
Visual C#を使用してDLLを作成する方法について簡単に説明します。
ありがとう、
簡単に使用できるAPIを作成したい場合、それは難しい場合があります。
まず第一に:インターフェースで考えます。提供する機能を必要としている人が使用できるインターフェイスを作成します。
そして:それをシンプルにしてください!
APIを開発するときは、せいぜい2つのプロジェクトを作成します。
そうすれば、完全なAPIと、APIの使用方法を示すサンプルができあがります。簡単な例では、説明よりも多くの価値があり、どのドキュメントよりも価値があります。(もちろん、APIで何ができるかを説明する必要があります)
そのまま使用できるクラスをAPIに提供します。つまり、APIのユーザーは、API内で実行できることを提供してはなりません。
楽しむ!
重要なことの基本的な理解を得たい場合は、このフレームワーク設計ガイドラインの本をお勧めします。独自のフレームワークを設計する予定がない場合でも読むことは非常に興味深いことであり、いくつかの決定を行う必要がある理由と行わない理由についての良い洞察を提供します。