Configuration and naming conventions for a multi-framework api
I am building an API called "Stima". The API is being built in three different languages/frameworks i.e Laravel, Golang & NodeJs. How do I go about naming; Please note that its literally the same functionality built using different technologies (thats the business model).
Repositories that will house the source code
Nginx configuration files (there exists staging and production configurations)
I know this is more of a "Do whatever works" kind of question but I would much love to have structure so that if the business decides on more and/or different frameworks, we don't end up in a state of utter confusion.
@kisiara One approach you could take for naming conventions is to use a consistent naming scheme for all of the different components of your API, regardless of the language or framework it's built in. For example, you could use the following naming conventions:
This naming scheme allows you to easily identify the language and framework used for each component of your API, as well as the environment it's intended for.
@tisuchi I really love this approach and more so that it starts with the name of the app so in case there are more apps then there will be name grouping.
If you don't mind a follow up question, how would you then go about naming the URLs; even more so now that there needs to be a distinction between staging and production environments.
@Kisiara May be will go with this approach for URLs, you can use a prefix to indicate the framework used, such as "laravel.stima.com", "golang.stima.com", and "nodejs.stima.com" for production and "staging.laravel.stima.com", "staging.golang.stima.com", and "staging.nodejs.stima.com" for staging.
@kisiara And it's also a good idea to document your naming conventions in a centralized location, such as a README file in each repository, so that it's easy for new developers to understand the structure and naming conventions used in the project.
