domain-raml-fragment

Domain Fragment RAML

A template with reusable fragments to boost your projects!

About The Project

The Domain RAML Fragment project aims to simplify the development of RAML (RESTful API Modeling Language) specifications by adhering to predefined data types and examples used within the business domain. It provides a collection of examples for data types that can be consistently applied across various RAML specifications within the same business domain.

Project Contents

The project contains a set of exemplary data types that serve as templates for different RAML specifications within a shared business domain. These examples are designed to ensure consistency and coherence across various API specifications.

These data types serve as building blocks for creating RAML specifications, providing a standardized and domain-specific approach to API development.

The Domain RAML Fragment project empowers developers to leverage consistent data types and examples across multiple RAML specifications within a specific business domain, promoting cohesion and efficiency in API development.

(back to top)

Usage Instructions

1. Create a new RAML Fragment project in Design Centre named: "Common RAML Fragments"
2. Go to your Design Centre Project and choose "Import", then select the ZIP.
3. Ensure you set the root RAML as the one which has been imported.
4. Publish this asset to Exchange.
5. This asset can now be imported into any new API Specification Design Centre project.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

Used as the basis for creating this template.

• Getting Started With RAML 1.0
• 3 types of API fragments design strategies
• Eliminate Redundancies in RAML with Resource Types and Traits
• RAML Version 1.0: RESTful API Modeling Language

(back to top)