web-dev-qa-db-ja.com

C＃でAPiを作成する方法は？

私はプログラミングを行ってきましたが、今は困難に直面しています。私は、ユーザー用にC＃でAPIを作成する必要があるプロジェクトに参加しています。基本的なプロセスは、XMLファイルを読み取り、タグ間にある属性と値を取得するC＃コードがあることです。私はそれを達成しました、そして今、私は同じ機能のために消耗品APIを作成しなければなりません。 APIの作成方法を学ぶ方法はありますか？

基本的に、APIを使用する方法については考えていません。どんな種類の例も私にとって有益です。

c#.netapi
20
Vikneshwar

APIは、他のプログラマーがコードとインターフェイスするための単なる方法です。 C＃クラスライブラリは、Webサービス、WCFエンドポイントなどと同様に、APIにすることができます。作成する最も簡単な方法は、C＃クラスライブラリプロジェクトを作成し、パブリックメソッドがあることを確認して、.dllにコンパイルすることです配布できます。

他の人が述べたように、フレームワーク設計ガイドラインは、いくつかのルールに従うのに役立ちます。

心に留めておくべきことの1つ-そして、これがすべての新しいソフトウェア開発者に打撃を与えることを望みます-API設計は基本的にユーザビリティの問題です。ソフトウェアのユーザー向けのUIを構築しているので、ユーザーは他のプログラマーです。

これは、UI/UX設計の一般的な原則（発見可能性、一般的なタスクの単純化など）に従うことを意味します。

XMLコメントを利用して、ドキュメントが常にそこにあることを確認してください。最も一般的なタスクは簡単に実行でき、その方法は明らかです。例外をきれいにし、実用的で実用的なエラーメッセージを含めます。消費者の生活を楽にするものを考えてください。

27
MNGwinn

C＃でAPIを作成することは大したことではありませんが、良いAPIを作成することは非常に困難です。

アセンブリをAPIとして配布する場合は、Visual Studioに クラスライブラリプロジェクト を追加するだけです。

または、APIをサービスとして公開する場合は、 [〜＃〜] wcf [〜＃〜] および Web Api を検討します。

優れた効率的なAPIを作成するには、学習する必要があります Framework Design Guidlines

8
Asif Mushtaq

あなたの質問は一般的ではありません。

しかし、私はあなたに答えようとします。 HTTP経由で呼び出すことができるAPIを作成する場合は、WCFを使用してこれを行うことができます。

Wcftutorial.netでWCFについて読むことができます。

DLLを使用してAPIを作成することもできます。また、読むようにお勧めします http://www.c-sharpcorner.com/UploadFile/mahesh/dll12222005064058AM/dll.aspx =

visual C＃を使用してDLLを作成する方法について簡単に説明します。

ありがとう、

5
Jigar Pandya

簡単に使用できるAPIを作成する場合、それは難題になる可能性があります。

まず第一に：インターフェイスで考えてください。提供する機能を必要とする人が使用できるインターフェースを作成します。

そして：シンプルにしましょう！

せいぜい、APIを開発するときに2つのプロジェクトを作成します。

  1. ユーザーが使用するAPI
  2. 既にAPIを使用しているサンプルプロジェクト/テストプロジェクト。

そのようにして、完全なAPIと、APIの使用方法を示すサンプルを作成します。サンプルは説明よりも多くのことを説明するため、ドキュメントよりも価値があります。 （もちろん、あなたはまだあなたのAPIを記述するものとしますcan）

そのまま使用できるAPIのクラスを提供します。つまり、APIのユーザーは、API内で実行できることを提供してはなりません。

楽しんで！

1
Mare Infinitus

何が重要かを基本的に理解したい場合は、 このフレームワーク設計ガイドラインの本 をお勧めします。独自のフレームワークの設計を計画していない場合でも読むことは非常に興味深いことです。また、いくつかの決定を行うべきであるのに、他の決定をしてはならない理由に関する優れた洞察を提供します。

0
Gorgsenegger