DotNet-201-ElevenNote
  • Introduction
  • ElevenNote (Parts 1-11)
    • Part 1: Setup
      • 0.0: Intro
      • 1.0: ElevenNote.WebMVC
      • 1.1: ElevenNote.Data
      • 1.2: ElevenNote.Models
      • 1.3: ElevenNote.Contracts
      • 1.4: ElevenNote.Services
      • 1.5: ElevenNote.Tests
    • Part 2: Identity Model
      • 2.0: Identity Model
      • 2.1: Entity Framework, References, Using Statements
      • 2.2: Identity Models Setup
    • Part 3: Database Setup
      • 3.1: Data
      • 3.2: Annotations
      • 3.3: Database and Connection String
      • 3.4: Guid Info
      • 3.5: Migrations
      • 3.6: Types
      • 3.7: Password Information
    • Part 4: NoteListItem
      • 4.0: MVC Intro
      • 4.1: Note Controller
      • 4.2: NoteListItem Model
      • 4.3: Index View
    • Part 5: NoteCreate
      • 5.0: NoteCreate
      • 5.1: NoteCreate Model
      • 5.2: Create View
      • 5.3: Change NoteCreate Model
      • 5.4: Create [Post] Method
      • 5.5: Navbar Addition
    • Part 6: NoteService
      • 6.0: NoteService
      • 6.1: NoteController Changes
      • 6.2: QuickWatch & Data
    • Part 7: Create Refactor
      • 7.0: CreateRefactor
      • 7.1: Validation Messages
    • Part 8: NoteDetail
      • 8.0: NoteDetail Model
      • 8.1: Detail View
      • 8.2: URL and Routes Discussion
    • Part 9: NoteEdit
      • 9.0: NoteEdit Model
      • 9.1: NoteEdit View
    • Part 10: NoteDelete
      • 10.0: NoteDelete
    • Part 11: DateFormat
      • 11.0: DateFormat
  • Star! (Part 12)
    • Part 12: Add Star Option
      • 12.0: Add Star Option
      • 12.1: Star Setup
      • 12.2: Star API
  • Notes and Tips
    • 0.0: Notes about Files, Saving, and Git
    • 0.1: Tips
    • 0.2: Resources
  • ElevenNote API (Parts 13-19)
    • Part 13: API Intro
      • 13.0: API Intro
      • 13.1: Test Login
      • 13.2: SSL
    • Part 14: WebAPI
      • 14.0: WebAPI Setup
      • 14.1: Testing with Postman
    • Part 15: API Controller
      • 15.0: API Controller
      • 15.1: Test Getting Notes in Postman
    • Part 16: Http Methods
      • 16.0: Http Methods
    • Part 17: Testing Endpoints
      • 17.0: API Documentation
      • 17.1: Test GetById
      • 17.2: Test Post
      • 17.3: Test Update
      • 17.4: Test Delete
    • Part 18: Swagger
      • 18.0: Swagger Setup
        • 18.0a: Swagger Config
      • 18.1: Test with Swagger
    • Part 19: PostMan Tips
      • 19.0: PostMan Tips
Powered by GitBook
On this page
  1. ElevenNote API (Parts 13-19)
  2. Part 18: Swagger

18.0: Swagger Setup

PreviousPart 18: SwaggerNext18.0a: Swagger Config

Last updated 6 years ago

Install and Setup Swagger

In this section, we set up Swagger, a tool that allows us to visualize all the endpoints of our API and easily test them.

  1. In Visual Studio, go to Tools -> NuGet Package Manager -> Package Manager Console

  2. Make sure ElevenNote.WebAPI is set as the default project

  3. Type install-package swashbuckle

    • Triple check that your default project is ElevenNote.WebAPI before you hit enter, my selection kept jumping to Models

    • Hit Enter

  4. When it's finished installing, close the Package Manager Console

  5. Go to ElevenNote.WebAPI -> App_Start -> SwaggerConfig.cs

  6. Replace the entire contents of the file with this code.

Next, we'll test endpoints in Swagger.

Git
Swashbuckle