Organizing project folder in C# .NET 6.0 API

Question

0.00/5 (No votes)

See more:

Hello, I intend to build a small microservice using Java, C#, and Python with 3
main table "Accounts", "Orders", and "Products". I have done a few small API projects with C# before, but I forget most of them.

Anyway, the OrderService is the C# one that I want to ask.
I intend to organize it like this:
//

OrderServiceSolution
    OrderServiceProject
        ControllerFolder
            OrderServiceController
    OrderServiceLib
        ServiceFolder
        RepositoryFolder
        Entity(Object)Folder

//
Will this be ok? And since there is only one service, I don't need to use Generic Repository right?

What I have tried:

In addition, should I connect to the database using appsettings.json like this?
How do real projects connect to the database?

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
            IConfigurationRoot configuration = builder.Build();
            optionsBuilder.UseSqlServer(configuration.GetConnectionString("EStoreDB"));            
        }

Posted 6-Oct-24 21:11pm

Hung Le Nguyen

Updated 7-Oct-24 21:29pm

Add a Solution

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Pete O'Hanlon · Accepted Answer · 2024-10-07T21:29:00

If the folders make sense to you, use them. Despite many opinionated people declaring that there is only "one true way" to do things like this, the reality is, as long as you are happy with it or, if you are doing this in an organisation that you align with project standards, then that's generally going to be good enough. Ultimately, naming is hard so if you get something that works for you, congratulations. Personally, I wouldn't have Folder in the name of a folder as that is redundant but that's me not you.

With regards to the configuration, I would try to avoid having sensitive configuration inside appsettings. There's too much risk of exposing secrets, such as database connection strings, if you accidentally commit them into something like github. In cases like this, I tend to use environment based configuration, and read this in from environment settings. That takes a bit of discipline, to make sure you remember to set that side up properly, but it reduces the likelihood of contaminating source control.