Skip to content

Design an API Specification with MuleSoft's no-code API Designer

Notifications You must be signed in to change notification settings

alexandramartinez/to-do-api-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 

Repository files navigation

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.

About

Design an API Specification with MuleSoft's no-code API Designer

Topics

Resources

Stars

Watchers

Forks

Languages