Skip to content

jonathanfiss/securities-raml-fragment

Repository files navigation

securities-raml-fragment

Contributors Forks Stargazers Issues MIT License


Securities Fragment RAML

A template with reusable fragments to boost your projects!

About The Project

The Securities RAML Fragment project aims to streamline the development of RAML (RESTful API Modeling Language) specifications by adhering to predefined standards for security schemas. It provides a set of reusable fragments focused on security, enabling the creation of consistent and standardized RAML specifications for APIs.

Project Contents

The project encompasses 7 distinct security schemas, each serving a specific purpose in securing your APIs:

  1. clientEnforcement: Standard client enforcement security schema.

  2. basicAuthentication: Basic authentication security schema.

  3. digestAuthentication: Digest authentication security schema.

  4. oAuth1.0: OAuth 1.0 authentication security schema.

  5. oAuth2.0: OAuth 2.0 authentication security schema.

  6. passThrough: Pass-through security schema.

  7. anotherAuthentication: Custom security schema tailored for specific requirements.

The anotherAuthentication security schema stands out as a customized solution, while the others are predefined by RAML. This diversity allows you to choose and implement the most suitable security measures for your API.

The Securities RAML Fragment project facilitates the integration of various security schemas into your RAML specifications, promoting a secure and standardized approach to API development.

(back to top)

Usage Instructions

  1. Create a new RAML Fragment project in Design Centre named: "Securities RAML Fragments"
  2. Add all the contents of this repository into a ZIP excluding the license and readme.md file.
  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.

(back to top)

About

No description or website provided.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages