Writing API in C# for My Application -

-

I will write an application, but I have not allowed people to use their application programming interfaces first. I mean, how should I kindly design people to let people use my methods like the API from outside the world.

Please someone shows me a path. I am new to this.

  1. Express as little as you can. Whatever you publish, it will come back to you x100 in the next version. Keeping consistency is very difficult.
  2. Create instability for whatever you publish You will definitely change your interior, but your existing users should stay consistent.
  3. Mark everything internally Even the main method of your application will be to use each one method that can be used.
  4. Check your public API in the same way that you would for the interface. Integration test and so on Note that your API will be used in an unexpected way.
  5. Maximize the conference on the configuration This is necessary even if your API is the only way, you will still need to support it.
  6. Resolve as many FxCop and StyleCop errors as possible.
  7. Check your API is consistent with the naming guidelines of your platform.
  8. Give as many examples as you can, and remember that most of your API usage will be Ctrl + C and Ctrl + V from these examples.
  9. Try providing documentation that you do not have GhostDoc-style auto-generated documents, everyone hates it.
  10. Include information about how to find you.
  11. Do not bother with ambiguity. This will help you and your users.

ADDED

  1. There should be less dependency in the API as you can. For example, dependence on IOC containers should be prohibited. If your code internally uses it just ask them in your assemblies.

Comments

Post a Comment

Popular posts from this blog

c# - ListView onScroll event -

-
I am programming a simple C # application, and I need a Scallow event on the list view. So I inherited the original ListView class created in ListviewEx witch. I found out how to locate the scroll message from WinAPI and I modified the WndProc method. Now I have this WndProc: protected override zero WndProc (Ref message message) {base.WndProc (Ref I); If (m.msg == WM_VSCROLL) {onScroll (This, New EventArgs ()); }} But the problem is, I do not know how to know about scrolling information. This data should be in wParam, but there is a LOWORD macro ++ like in C in C # and I switch to find the criteria like SB_ below, SB_ENDSCROLL, SB_PAGEUP etc. there any way Need to change the LOWORD macro from C #? Or any other way to find the necessary parameters about scrolling? You can define the WParam constants as the following: Private const int WM_HSCROLL = 0x114; Private Constant WM_VSCROLL = 0x115; Private contact int SBHOZZ = 0; Private Consultant SB_VERT = 1; Private Con...
Read more

PHP - get image from byte array -

-
I am trying to create a back-end for my mobile application. I am sending the content of an image in the body of the HTTP request (output stream) as a byte array, I want to read this stream of bytes in PHP scripts and take back an image. Can anyone tell me how can I do this? Thank you. You can obtain the request body $ body = Reading from file_get_contents ('php: // input'); What you do with that data Depending on you, you can write the data in a file as you mentioned that this is image data, you can drop the data into the object can do. Another option is to use and load the image.
Read more

Linux Terminal Problem with Non-Canonical Terminal I/O app -

-
I have a small app written in C to run on Linux. Part of the app accepts user-input from keyboard , And it uses non-canonical terminal mode so that it can respond to each keystroke. The section of the code that accepts input is a simple task that is called repeatedly in the loop: char get_input () {char C = 0; Int res = reading (input_tamille, & amp; c, 1); If (RSS == 0) 0 returns; If (res == -1) {/ * snip error handling * /} return c; } It reads a letter from the terminal if there is no input within a given time limit, (c_cc [VTIME] value in the vocabulary structure), read () 0 And get_input () is called again It all works very well, I have recently discovered that if you run this app in a terminal window, and then the app Close the terminal window without ending, the app will not exit Received, but CPU intensive launches into an infinite loop, where the read () returns 0 without waiting continued. So how can I get out of the apple if it runs from the terminal win...
Read more