List functional requirements for the system (Ask the chat bot for hints if stuck.)...
List non-functional requirements for the system...
Define what APIs are expected from the system...
// The API to post the text to store
POST v1/text/
paste: String // the text to store
language: enum
response: 201 created (textId)
GET v1/text/{textId}
response: 200 -
paste: string // text to return
language: enum
404 - paste not found
400 - bad request
DELETE v1/test/{textId}
response 204
404 - The content doesn't exist
401 - The user does not have permission to delete the content
You should identify enough components that are needed to solve the actual problem from end to end. Also remember to draw a block diagram using the diagramming tool to augment your design. If you are unfamiliar with the tool, you can simply describe your design to the chat bot and ask it to generate a starter diagram for you to modify...
The system should consist of a client, a server, a database to serve the basic requests. In order to remove the expired texts from the database, there should be a seperate cronjob that is executed daily.
Dig deeper into 2-3 components and explain in detail how they work. For example, how well does each component scale? Any relevant algorithm or data structure you like to use for a component? Also you could draw a diagram using the diagramming tool to enhance your design...
Defining the system data model early on will clarify how data will flow among different components of the system. Also you could draw an ER diagram using the diagramming tool to enhance your design...
Table: Text
Id (varchar): id of text
ownerId (varchar): customerId of the creator of the text.
textToStore (varchar): the text to store
uri: uriOfText
insertTime (DateTime)
expireTime (DateTime)