1

JAXB を使用して JSON を生成する方法を理解したので、サーバーでそれを要求/応答できます。Java を使用していない人間に役立つドキュメントを生成する方法を理解したいと思います。私のサーバーコードは次のようになります。

@POST
@Path("apath")
@Consumes(MediaType.APPLICATION_JSON)
public String postAPath(InstanceWithXmlRootElementAnnotation instanceWithXmlRootElementAnnotation) {

誰かがJavaを使用している場合、それはすべてうまくいきます。クラスが入ったJarを渡して、InstanceWithXmlRootElementAnnotationそれを送るように伝えます（はい、もう少し作業があります。それらの詳細は無視してください）。

彼らが他の言語を使用している場合、ペイロードの形式と、サーバーがInstanceWithXmlRootElementAnnotation. JSON ペイロードの予想される形式を説明するドキュメントを生成するにはどうすればよいですか?

4

4 に答える 4

1

Swagger は、他の機能アノテーションと混同する可能性のあるアノテーションを使用します。

APIDOCを使用して、機能的な注釈とドキュメントを適切に分離します。各メソッドの上の通常のドキュメントのように見えます。元：

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */
于 2015-04-26T18:30:07.180 に答える
0

Swagger は (@fehguy ごとに) 適切なオプションであり、enunciateもチェックして、アプリケーションに最適なものを確認する必要があります...

于 2013-09-11T00:37:25.667 に答える
0

enunciate も試してみてください。サービス クラスの javadoc および JAX-RS アノテーションを解析してドキュメントを生成します。

http://enunciate.codehaus.org/

以下は、enunciate によって生成されたドキュメントの例です。

https://repository.sonatype.org/nexus-restlet1x-plugin/default/docs/index.html

うまく機能する maven プラグインがあります。また、さまざまな言語のクライアント ライブラリと、xml ベースのサービス用のサンプル xml を生成します。Swagger ドキュメントもサポートするようになりました。

于 2014-07-25T16:02:49.533 に答える