Marmiton-API

Project Overview

Welcome to the Marmiton-API repository! This project provides a comprehensive collection and Postman documentation for interacting with the Marmiton API. The Marmiton API enables users to perform various actions related to account management, favorites, search, selections, dish details, and additional functions.

Documentation

Explore the detailed API documentation using Postman: Marmiton-API Documentation

Table of Contents

• Account Management
• Favorites Management
• Search and Autocomplete
• Selections and Suggestions
• Dish Details
• Additional Functions
• Project License
• Credits
• Importing the Collection in Postman

Account Management

• Check Username:

  • Verify the availability of a username.

• Create an Account:

  • Register a new account.

• Log in to an Account:

  • Authenticate and log in.

• Delete an Account:

  • Permanently remove the account.

• Update Profile:

  • Modify user profile information.

Favorites Management

• Get the List of Favorites:

  • Retrieve the list of favorited dishes.

• Add a Dish to Favorites:

  • Include a dish in the favorites.

• Remove a Dish from Favorites:

  • Delete a dish from favorites.

Search and Autocomplete

• Search for Dishes:

  • Conduct a search for specific dishes.

• Autocomplete Dish Names:

  • Automatically complete dish names.

• Autocomplete Ingredient Names:

  • Automatically complete ingredient names.

Selections and Suggestions

• Obtain the List of Selections:

  • Retrieve available selections (Summer, Winter, etc.).

• Get the List of Dishes for a Selection:

  • Access the list of dishes for a specific selection.

• See Some Suggestions:

  • View suggested dishes.

• Discover Your Suggestions:

  • Explore personalized dish recommendations.

Dish Details

• Get the Details of a Dish:
  • Retrieve comprehensive information about a specific dish.

Additional Functions

• Send a Photo of a Dish:
  • Upload and submit a photo of a dish.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits

If you find this repository helpful and use it to set up your system, we kindly request that you provide attribution to the original author. You can include a credit in your project documentation, website, or any appropriate place, mentioning the source:

"Marmiton-API by grantUser - https://github.com/grantUser/marmiton-official-api"

Thank you for your understanding and cooperation!

Importing the Collection in Postman

To import the Marmiton-API collection into Postman, follow these steps:

1. Open Postman and click on the "Import" button located in the top-left corner.

2. In the import modal, select the "File" tab.

3. Upload the Marmiton-API Collection JSON file.

4. Click the "Import" button, and the Marmiton-API collection will be added to your Postman workspace.

Now, you can easily explore and test the Marmiton API endpoints using the imported collection.

Thank you for your understanding and cooperation!