インクルード、ライブラリ、オーバーレイ、および拡張機能を使用したモジュール式RAML

#%RAML 1.0
title: Baeldung Foo REST Services API
...
types: !include/types/allDataTypes.raml
resourceTypes: !include allResourceTypes.raml
traits: !include http://foo.com/docs/allTraits.raml

#%RAML 1.0 <fragment-type>

#%RAML 1.0 Trait

traits:
  - hasRequestItem:
      body:
        application/json:
          type: <<typeName>>
  - hasResponseItem:
      responses:
          200:
            body:
              application/json:
                type: <<typeName>>
                example: !include examples/<<typeName>>.json

traits:
  - hasRequestItem: !include traits/hasRequestItem.raml
  - hasResponseItem: !include traits/hasResponseItem.raml

#%RAML 1.0 Trait
body:
  application/json:
    type: <<typeName>>

#%RAML 1.0 Trait
responses:
    200:
      body:
        application/json:
          type: <<typeName>>
          example: !include/examples/<<typeName>>.json

#%RAML 1.0 Library
# This is the file/libraries/traits.raml
usage: This library defines some basic traits
traits:
  hasRequestItem:
    usage: Use this trait for resources whose request body is a single item
    body:
      application/json:
        type: <<typeName>>
  hasResponseItem:
    usage: Use this trait for resources whose response body is a single item
    responses:
        200:
          body:
            application/json:
              type: <<typeName>>
              example: !include/examples/<<typeName>>.json

#%RAML 1.0
title: Baeldung Foo REST Services API
uses:
  mySecuritySchemes: !include libraries/security.raml
  myDataTypes: !include libraries/dataTypes.raml
  myResourceTypes: !include libraries/resourceTypes.raml
  myTraits: !include libraries/traits.raml

#%RAML 1.0 Library
# This is the file/libraries/resourceTypes.raml
usage: This library defines the resource types for the API
uses:
  myTraits: !include traits.raml
resourceTypes:
  item:
    usage: Use this resourceType to represent any single item
    description: A single <<typeName>>
    get:
      description: Get a <<typeName>> by <<resourcePathName>>
      is:[myTraits.hasResponseItem, myTraits.hasNotFound]    put:
      description: Update a <<typeName>> by <<resourcePathName>>
      is:[myTraits.hasRequestItem, myTraits.hasResponseItem, myTraits.hasNotFound]    delete:
      description: Delete a <<typeName>> by <<resourcePathName>>
      is:[myTraits.hasNotFound]      responses:
        204:

RAML 1.0 Overlay

RAML 1.0 Extension

#%RAML 1.0
title: API for REST Services used in the RAML tutorials on Baeldung.com
documentation:
  - title: Overview
  - content: |
      This document defines the interface for the REST services
      used in the popular RAML Tutorial series at Baeldung.com.
  - title: Copyright
  - content: Copyright 2016 by Baeldung.com. All rights reserved.

#%RAML 1.0 Overlay
# File located at (archivo situado en):
#/overlays/es__ES/documentationItems.raml
masterRef:/api.raml
usage: |
  To provide user documentation and other descriptive text in Spanish
  (Para proporcionar la documentación del usuario y otro texto descriptivo
  en español)
title: |
  API para servicios REST utilizados en los tutoriales RAML
  en Baeldung.com
documentation:
  - title: Descripción general
  - content: |
      Este documento define la interfaz para los servicios REST
      utilizados en la popular serie de RAML Tutorial en Baeldung.com.
  - title: Derechos de autor
  - content: |
      Derechos de autor 2016 por Baeldung.com.
      Todos los derechos reservados.

#%RAML 1.0 Extension
# File located at:
#/extensions/en__US/additionalResources.raml
masterRef:/api.raml
usage: This extension defines additional resources for version 2 of the API.
version: v2/foos:
 /bar/{barId}:
    get:
      description: |
        Get the foo that is related to the bar having barId = {barId}
      typeName: Foo
      queryParameters:
        barId?: integer
        typeName: Foo
        is:[hasResponseItem]----

そして、これがそのためのスペイン語の__overlay__です。

[source,javascript,gutter:,true]

この例ではスペイン語のオーバーライドに__overlay__を使用していますが、APIの動作は変更されていないため、このモジュールを__extension__に定義することも簡単にできます。その目的は、その上の英語の__extension__にあるプロパティを上書きすることであることを考えると、それは__extension__としてより適切に定義されるかもしれません。

===  **  6. 結論**

このチュートリアルでは、共通の構成要素を外部ファイルに分離することによってRAML API定義をよりモジュール化するためのいくつかの手法を紹介しました。

まず、RAMLの__include__機能を使用して、個々の複雑なプロパティ値を__typed fragments__として知られる再利用可能な外部ファイルモジュールにリファクタリングする方法を示しました。次に、__include__機能を使用して特定の要素セットを再利用可能な__libraries__に外部化する方法を示しました。最後に、__overlays__と__extensions__を使用して、APIの動作面と非動作面を拡張しました。

RAMLのモジュール化手法の詳細については、https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#modularization[RAML 1.0 spec]を参照してください。 。

このチュートリアルで使用されているAPI定義の** 完全な実装** はhttps://github.com/eugenp/tutorials/tree/master/raml/modularization[githubプロジェクト]で確認できます。

次 ** "**

https://www.baeldung.com/raml- custom-properties-with-annotations

** «** 前へ

https://www.baeldung.com/simple-raml-with-resource-types-and-traits[エリミネイト
リソースタイプと特性によるRAMLの冗長性]