https://github.com/alexandramartinez/to-do-api-spec

Design an API Specification with MuleSoft's no-code API Designer
https://github.com/alexandramartinez/to-do-api-spec

api-spec api-specification mulesoft oas raml

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/alexandramartinez/to-do-api-spec
• Owner: alexandramartinez
• Created: 2024-06-18T19:56:16.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-19T15:07:49.000Z (7 months ago)
• Last Synced: 2024-10-21T05:29:30.888Z (2 months ago)
• Topics: api-spec, api-specification, mulesoft, oas, raml
• Language: RAML
• Homepage:
• Size: 3.91 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# To-Do API Specification in RAML/OAS

This content has been reformatted to fit different audiences.

- [Blog post] [How to use MuleSoft's visual API Designer to create a To-Do API specification using clicks, not code](https://www.prostdev.com/post/how-to-use-mulesoft-s-visual-api-designer-to-create-a-to-do-api-specification-using-clicks-not-code)

- [Short video] [Use MuleSoft's visual API Designer to create a To-Do API specification | #Codetober 2023 Day 4](https://www.youtube.com/watch?v=8TqtcafHNT8)

- [Full video] [Build a To-Do App with MuleSoft’s API Design GUI | Mini Hacks Solved | Season 02](https://www.youtube.com/watch?v=Vcs5fiYUnTY)

- [Slides] [Dreamin in Color '24 - (Workshop) Design an API Specification with MuleSoft's no-code API Designer](https://www.slideshare.net/slideshow/dreamin-in-color-24-workshop-design-an-api-specification-with-mulesoft-s-no-code-api-designer-pptx/269767697)

## 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](https://raml.org/) or [OAS](https://swagger.io/specification/). 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](https://anypoint.mulesoft.com/) 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](https://www.codecademy.com/article/what-is-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](https://www.alexmartinez.ca/).