Giter Club home page Giter Club logo

contosopizza-api's Introduction

ContosoPizza API

Introduction

The ContosoPizza API is a demonstration project showcasing a simple, in-memory RESTful API for managing pizza orders. Built with ASP.NET Core, this API supports basic CRUD operations and provides a solid foundation for understanding how web APIs work in .NET environments.

Getting Started

Prerequisites

Before you start, ensure you have the following installed:

  • .NET 6 SDK or later
  • A preferred code editor (Visual Studio, VS Code, etc.)
  • Postman or a similar tool for testing API endpoints

Installation

To get the project running on your machine, follow these steps:

  1. Clone the repository:
    git clone https://github.com/realYushi/ContosoPizza-API.git
  2. Navigate to the project directory:
    cd ContosoPizza
  3. Restore dependencies:
    dotnet restore
  4. Start the application:
    dotnet run

Configuration

The launchSettings.json file in the project defines how the application should be launched, especially in development environments. Here's a quick overview of its sections:

iisSettings

Configures settings for running the application with IIS Express, including authentication modes and application URLs.

profiles

Defines various launch profiles for the application:

  • https: For launching the application with HTTPS support.
  • http: For launching the application using HTTP.
  • IIS Express: For running the application through IIS Express with predefined environment variables and launch URLs.

Each profile includes settings for launching the browser, specifying the launch URL, defining application URLs, and setting environment variables.

Running the Application

You can specify the launch profile directly when running the application using the .NET CLI:

dotnet run --launch-profile http

Or, if you are using Visual Studio, you can select the launch profile from the debug menu.

Contributing

Your contributions are welcome! Feel free to fork the repository, make changes, and submit pull requests. If you have any suggestions or encounter issues, please open an issue in the repository.

contosopizza-api's People

Watchers

Yushi Cui 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.