Intelligence Center

Appearance

Request Naming ​

Learn our recommended request naming convention for organized, readable, and collaborative Wized projects.

On this page, you can find our recommendations for naming requests.

Summary/Cheat Sheet ​

Here's a quick summary of our naming convention. If this is your first time on this page, we encourage you to skip the cheat sheet, and read on from there.

We recommend using keywords that represent basic CRUD operations, and Title Case. This way, you can see at a glance whether your requests are Data In or Data Out requests.

Request Naming: ​

  • Get User
  • Get Cart Items
  • Get Products
  • Get All Users
  • Create Cart Item
  • Create Order
  • Update User
  • Update Account Info
  • Delete All Cart Items

Why Title Case? ​

We recommend using Title Case for requests for improved readability

Capitalizing the first letter of most words can improve the readability of the request name by making it easier to distinguish individual words.

Request Naming: ​

Use the "create", "update", "delete", and now "get" keywords to represent the basic CRUD operations.

Also, make sure that your requests are descriptive. This way, it will be easier to understand at a glance what each request is doing.

So avoid abbreviations, and non-descriptive names like these:

  • Get Bg Imgs
  • Del User A
  • Put DB item

Instead, use a descriptive label like these:

  • Get Background Images
  • Delete Admin User
  • Update Cart Item

By following this convention, you'll ensure a clear understanding of each request's purpose and maintain a coherent naming structure across your project.

Now, we're going to dive into more specific examples for each request.

Data In requests ​

Prepend the word "get" and use a descriptive name. For example:

  • Get User
  • Get Cart Items
  • Get Products
  • Get All Users

Data Out requests ​

Prepend the words "create", "update", or "delete".

  • Create Cart Item
  • Create Order
  • Delete All Cart Items
  • Update User

Conflicts ​

If you're in a conflict with naming, don't overthink it.

Just make a decision and move forward.

The decision to give a good name to a request might not always be clear. That's ok. Pick something and move on.

Taking too much time to think about naming is not advised. And breaking your workflow to overthink naming is also not advised.