0

RAML を使用して REST コントラクトを指定していますが、POST メソッドでコントラクトをより適切に記述する方法があるかどうかを知りたいです。

実際、私の POST メソッドは次の情報を表示します。

<application>
  <grammars/>
  <resources base="http://localhost:8080/ouat-servicesImpl/api">
    <resource path="/topics">
      <method name="POST">
        <request>
          <representation mediaType="application/json"/>
        </request>
        <response>
          <representation mediaType="application/json"/>
        </response>
      </method>
    </resource>
  </resources>
</application>

表現の詳細を公開する構成はありますか? タグの例を試しましたが、機能しません

私の RAML ドキュメント:

schemas:
  - error:       !include schemas/error.json
  - topic:       !include schemas/topic.json
  - topicCreate: !include schemas/topicCreate.json

/topics:
  description: Topic resource.
  displayName: Topic
  post:
    description: Create topic.
    securedBy: [oauth_2_0]
    body:
      application/json:
        schema: topicCreate
    responses:
      201:
        description: Success
        body:
          application/json:
            schema: topic
            example: topic
      400:
        body:
          application/json:
            schema: error
            example: error

次のような外部JSONドキュメントを使用しています

{
  "$schema": "http://json-schema.org/schema",
  "type" : "object",
  "description": "The canonical topic representation.",
  "properties" : {
    "id" :       {"type" : "string"},
    "writerID" : {"type" : "string"},
    "text" :     {"type" : "string"}
  },
  "required" : ["id", "text", "writerID"]
}

私が多くのSOAPコントラクトを使用した限り、リクエストとレスポンスにより多くの情報が表示されることを期待していました

4

1 に答える 1