See how Web API help pages can help you automatically create API documentation.
- [Instructor] Over all the real world APIs that I've built,…I've found it to be very important…to provide good documentation for them.…Doing so allows front-end developers or other API consumers…to be able to explore the provided APIs…and see what end-points are available, how they work,…the shape of the inputs and outputs,…and what they can expect to send and receive.…Of course, most developers don't like creating documentation…and even when someone does do it…it seems like it's often out-of-date very quickly.…
It's for all these reasons that I like to create…auto-generated documentation for my APIs.…I'll show you a couple of different tools that you can use…to automatically create documentation for your APIs…which is based almost entirely on your code…with the addition of some XML-formatted comments…that you've placed inline in that code to document it.…Both of the API documentation tools…that I'm going to show you,…use the optional XML documentation file…that the dotnet compiler is capable of creating…from your inline code comments.…
AuthorJonathan "J." Tower
- Convention-based routing
- Binding your code to an HTTP request
- Validating models
- Using attributes to route requests
- Customizing attribute routes
- Data serialization and model binding
- Error handling
- Using exception filters and exception loggers
- API documentation and testing
- Securing your API
Skill Level Beginner
1. Controllers and Actions
3. Data Serialization and Model Binding
4. Error Handling
5. API Documentation and Testing
Next steps1m 38s
- Mark as unwatched
- Mark all as unwatched
Are you sure you want to mark all the videos in this course as unwatched?
This will not affect your course history, your reports, or your certificates of completion for this course.Cancel
Take notes with your new membership!
Type in the entry box, then click Enter to save your note.
1:30Press on any video thumbnail to jump immediately to the timecode shown.
Notes are saved with you account but can also be exported as plain text, MS Word, PDF, Google Doc, or Evernote.