Git Product home page Git Product logo

to-do-api-spec's Introduction

To-Do API Specification in RAML/OAS

This content has been reformatted to fit different audiences.

The use case

You need to create a To-Do app to manage tasks.

The first step is to design the API Specification. An API specification is usually created using either RAML or OAS. However, because you are on a time crunch and are not very familiar with these languages, you decide to use MuleSoft for this.

MuleSoft provides a graphical user interface (GUI) in Anypoint Platform to complete this specification using clicks, not code.

What you learn

Without having to code in RAML/OAS, using the visual UI to click your way through the design, you will learn:

  • The basic navigation of Design Center in Anypoint Platform
  • How to create a new API specification
  • How to create and what is a data type
  • How to create and what is a resource
  • What is a nested resource
  • How to make use of a URI Parameter
  • Designing CRUD resources
  • Differences between GET, POST, PUT, and DELETE methods
  • Setting up Query Parameters
  • Setting up Request and Response bodies
  • Successful status codes (200, 201, 204)
  • How to publish an API spec to Anypoint Exchange
  • How to verify a published API spec
  • How to download the created RAML/OAS specification from Design Center

Questions?

For any questions after reviewing the resources at the top, you can create an issue on this repo or reach out to me through my channels available at alexmartinez.ca.

to-do-api-spec's People

Contributors

alexandramartinez avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.