APIリファレンスについて

API

APIとは、アプリケーションプログラミングインターフェース(Application Programming Interface)の略です。ソフトウェアの機能を共有する仕組み」のことです。よく使う機能がAPIとして用意されていれば、わざわざいちからプログラムを組む必要はありません。必要に応じてAPIを利用し効率的に開発を進めることができます。APIには、データ構造、オブジェクトクラス、変数などの仕様が含まれます。また、APIには様々な形態があります。国際標準規格、ベンダーによる文書（マイクロソフトのWindows API等）、プログラミング言語の標準ライブラリ（C++のStandard Template Library、Java API等）、Webサービスがアプリ開発者向けに公開するWebAPI等があります。公開されているWebAPIでは、「Facebook」「LINE」「Twitter」「YouTube」「Google Map」「Amazon」などが有名です。今記事では、プログラミング言語の標準ライブラリ「Java API リファレンス」について紹介します。

Java APIリファレンス

JavaにおけるAPIとは、クラスをまとめたクラスライブラリのことです。 APIリファレンスとは、Java APIの情報を網羅した公式ドキュメントの事を指します。その中にはJavaの「パッケージ、クラス、コンストラクタ、フィールド、メソッド」等の細かな仕様などJava開発者のための様々な情報が記載されています。APIリファレンスに記載されているクラスファイルは4000程の内容があるとされており、そのひとつひとつに大量のメソッドが格納されています。これらの情報を全て覚えることは困難です。APIリファレンスはJava開発元のOracleのWebサイトで公開されているため、上手く参照しJava開発者はプログラムを書く中で必要に応じて調べることで、効率よく活用する事ができます。

Java APIリファレンス 種類

＜コア API ドキュメント＞
コアAPIドキュメントとは、コアAPIの説明書です。コアAPIとは、頻繁に使用されるプログラミングの核となるクラス・メソッドを指します。

＜JDK プログラマーズ・ガイド＞
JDKとは、「Java Development Kit」の略です。Javaを用いて開発を行うための基本ツールです。JDKを使用することで、Webアプリケーションやスタンドアロンアプリケーションを作成することができます。プログラマーズ・ガイドには、開発を行うための手順やヒントなどが記載されています。

＜JDK に含まれるコア以外の API＞
コア以外の、特殊な処理や専門的な処理を行いたい場合に用いるクラス・メソッドの説明書が記載されています。

Java APIリファレンス ダウンロード

基本的にはインターネット環境のある場合には、Java開発元のOracle社のWebサイトで公開されているため、ダウンロードの必要はありません。インターネットのない環境でJavaAPIリファレンスを参照したい場合には事前にダウンロードする必要があります。ダウンロードすることでインターネット環境がなくても参照することができるようになります。 Oracle社のWebサイトでダウンロードページを開き、使用するJavaのバージョンを選択しダウンロードを行いましょう。バージョンにより使い方が異なったり、使用が非推奨となるものもあるため使用するJavaのバージョンをよく確認してから、APIリファレンスを参照しましょう。

Java APIリファレンス 使い方

APIリファレンスは、「パッケージを選択するエリア（左上）」「選択したパッケージに含まれるクラス一覧が表示・選択されるエリア（左下）」「選択したクラスの説明や含まれるメソッドの説明が表示されるエリア（右側）」のそれぞれのグループで表示が分かれています。パッケージとはJavaの名前空間にあるクラスやインタフェースをまとめた機能、クラスやインタフェースにはさらに固有機能を使用するためのメソッドがあります。 今記事では、JavaAPIリファレンスから使用頻度の高い「String」クラスを例に読んでいきます。

1.JavaAPIリファレンスにアクセスします。（Java(tm) Platform, Standard Edition）
2.左下のグループから「String」を探し、クリックすることでクラスの概要、定義方法、使用方法などクラスを使用するのに必要な情報を表示させることができます。
3.「String」クラスで使用できるメソッドは、「String」クラスのページ下に「メソッドのサマリー」として一覧表示されています。デフォルトでは「全てのメソッド」表示ですが、他にも「staticメソッド」「インスタンスメソッド」「具象メソッド」などメソッドを種類別に表示して表示させることもできます。使用したいメソッドをクリックすることでより詳細にメソッドの解説を表示することも可能です。