REST API Practice - Tell Good API

OOCL

Function-driven vs Data-driven

As a Author UI i want to crate a Post so that i can see all posts and read indicated post content later

Create a post

http：//api.blog.com/createPost
body: {tittle: "my article", {content: "my article bit content"}}

POST http：//api.blog.com/Posts
body: {tittle: "my article", {content: "my article bit content"}}

Get all posts List

http：//api.blog.com/getPostList

GET http：//api.blog.com/Posts

Get a indicated post

http：//api.blog.com/getPostById?id=3

GET http：//api.blog.com/Posts/3

As a Author i want to delete a indicated post directly

http：//api.blog.com/deletePostById?id=3

DETELE http：//api.blog.com/Posts/3

As a Author i want to update content of a indicated post

http：//api.blog.com/updatePostById?id=3

PUT http：//api.blog.com/Posts/3

As a Reader i want to comment the indicated post

http：//api.blog.com/addCommentToPostById
body: {postId: "3", tittle: "my article", {content: "my article bit content"}}

POST http：//api.blog.com/Posts/3/Comments
body: {tittle: "my article", {content: "my article bit content"}}

As a Reader i want to see all comments in a indicated post

http：//api.blog.com/getAllCommentsByPostId?postId=3
body: {postId: 3, content: "my comments"}

POST http：//api.blog.com/Posts/3/Comments
body: {content: "all comments for this post"}

As a Manager i want to delete indicated comment in any post

http：//api.blog.com/deleteCommentsByPostIdAndCommentId?postId=3&commentId=2

DELETET http：//api.blog.com/Posts/3/Comments/2

As a Reader i want to update indicated comment in any post

http：//api.blog.com/updateCommentsByPostIdAndCommentId?postId=3&commentId=2
body: {content: "update this comment"}

PUT http：//api.blog.com/Posts/3/Comments/2
body: {content: "update this comment"}

As a Manager i can help vip author create a post and assign the post to this author

http：//api.blog.com/createPostForIndicateAuthorByManager?AuthorId=2&ManagerId=1
body: {tittle: "my article", {content: "my article bit content"}}

POST http：//api.blog.com/Authors/2/Posts
body: {tittle: "my article", {content: "my article bit content"}}

As a Author i can create a post by myself

http：//api.blog.com/createPostByAuthor?AuthorId=2
body: {tittle: "my article", {content: "my article bit content"}}

POST http：//api.blog.com/Authors/2/Posts
body: {tittle: "my article", {content: "my article bit content"}}

As a manager i can get pagable comments belong to a indicate author

http：//api.blog.com/getAllCommentsByAuthorId?AuthorId=2&page=1&pageSize=10

GET http：//api.blog.com/Authors/2/Comments?page=1&pageSize=10