Best practices for building RESTful ASP.NET APIs include keeping the API design simple to meet consumer needs, using a limited set of HTTP status codes consistently, and structuring resources hierarchically. The API implementation should accept and respond with JSON, use URL versioning, implement authentication securely, and handle errors gracefully. Documentation should be maintained with developer readability in mind, and performance considerations like caching should be made. Overall consistency, clarity, and standards adherence are important.

1. Best Practice for Asp.net API
• Restful API != Good API.
• Do what makes Sense
• Do what consumers need
Most Important things to recall

2. Design API
Tips
• Keep it Simple( Simple != Easy)
• No need to be creative
• Use handful of http Code
• Return/Provide what is needed
• Structure APi to make finding error easy
• Nesting resources for hierarchical objects.

3. Be
consistent
with the ff:
• Plurality
• Use of Nouns and verbs
• Result size
• Sorting and filtering
• Paging

4. Implementation
• Accept and respond with JSON.
• Versioning--> API should
stand the test of time
• Use URL versioning
• Use SSL
• Pick and
Authentication strategy that is
not basic
• Use DTO

5. Implementation continued
• Controller should know "Where" not "how"
• Keep validating in back end side
• Separate validation logic from object
• Handle errors gracefully and return standard error
codes.
Controller Request Validator
Handler
Service

6. Documentation
• Use Documentation Tools
• Keep Updated
• Remove Properties on maintenance phase
• Make easy for everyone to read
• Test readability with other devs

7. Upon deprecation
• Give notice for deprecation
• Point out different version or
replacement to every method and
address that is deprecated

8. Performance
tips
Performance is also an
important consideration.
Avoid returning too much
data at once.
Use caching to avoid repeated
queries

9. Last
General
Tips
• have consistency by following web
standards and conventions
• Paths of endpoints should be consistent
• use nouns only since the HTTP methods
indicate the action we want to take.
• Paths of nested resources should come after
the path of the parent resource.
• Paths should tell what is returned or
manipulated without the need to read extra
documentation to understand what it’s
doing.