api - how to start to write an SDK for php MVC self created framework -



api - how to start to write an SDK for php MVC self created framework -

i don't know how inquire question ,but here comes:

my boss wanted me create simple mvc php our online-shopping website , did ( watching youtube , ...) , it's simple , made .

now keeps asking me :

first create restful api ( uses curl ).

second create documented sdk !!.

i've searched lot (really ) , right know can understand api i'm not sure what's sdk , how start write code

can give me line of code of illustration of how start write ?

what means **well documented ** ?

i've searched in google , know sdk , api literally mean, problem can't create relation between mvc , api , sdk .

how can start write api ?

where should begin ?

what's point ?

can give me illustration ?

what sdk supposed ?

i've seen lots of videos api , of them talks using rest , rest , should get/post/delete/put , on , forcefulness .

but should start ?

edit

in case , online-shopping searchs through our mongodb database , returns new products , other simple tasks , how should utilize restful api ? or skd ?

thanks , please tell me if explanation not understandable .

looks have task ahead of you.

restful routing

restful routing way of communicating server via standard http protocols. these things get, post, put, delete, etc...

when routing in restful way, not need phone call ambiguous methods retrieve, update, or delete info on server.

for example, when attempting retrieve users server, might have create phone call http://domain.tld/getallusers.php. not restful.

however, if retrieve users making phone call http://domain.tld/users/ , specify want access phone call via get, built in http protocol, restful.

there many resources online learning more restful routing.

apis

apis application programming interafaces. instance, when using restful routing construction application, implementing api, because giving others way access info on server.

however, apis not restful. in fact, many not, , these more hard application programmers larn because not follow standard.

there have been many books written apis , more can cover in response. book recommend build apis won't hate phil sturgeon.

sdks

sdks software development kits , while of time extensive, restful api developing constitute sdk.

this might not boss wants though, have inquire him.

documentation

well documented code easy read , easy understand. require grasp of language target audience uses.

the first step in writing documentation writing commented code. having commented code best documentation can have , after written, can utilize tool such phpdoc generate documentation you. generation might not extensive like, , means need more comments.

some recommendations

read through code other developers have implemented things seeking. biased in instance because current framework of choice, laravel php mvc framework of well. code documented , easy understand.

in addition, there lot of written packages on packagist might of help you, should check them out , composer if haven't already.

if reading finds mistakes please right me.

php api rest sdk

Comments

Post a Comment

Popular posts from this blog

Delphi change the assembly code of a running process -

Delphi change the assembly code of a running process - i'm trying alter address 00741fa5 has push test.009e721c . alter push test.009e71c8 . procedure callback; asm force $9e71c8 end; procedure tform2.btn1click(sender: tobject); var ppid :dword; pprocess : cardinal; begin getwindowthreadprocessid(findwindow(nil,pchar('test')), @ppid); pprocess := openprocess(process_all_access, false, ppid); injectasm(pprocess, $741fa5, 10, integer(@callback), 0); end; here injectasm function (with error checking) function injectasm(process: longword; injectaddress, injectsize, codeaddress, codesize : integer): pointer; var csize, rsize : integer; replaced : array of byte; jmp : array [0..4] of byte; jmpaddress : integer; nopv : byte; : integer; nbr: ulong_ptr; begin //injectsize must equal or greater 5, because need space our //(far) jmp wwxxyyzz instruction //if there's no space, inject in place of few instructions if injectsize ...
Read more

json - Hibernate and Jackson (java.lang.IllegalStateException: Cannot call sendError() after the response has been committed) -

json - Hibernate and Jackson (java.lang.IllegalStateException: Cannot call sendError() after the response has been committed) - hello have problem hibernate , jackson. have 2 pojos @entity @table(name = "users") public class user implements serializable { static final long serialversionuid = 4235637833262722256l; @id @generatedvalue private int id; @column(name = "creation_date") private date creationdate; @column(name = "first_name") private string firstname; @column(name = "last_name") private string lastname; @version @column(name = "version") private int version; @column(name = "e_mail") private string email; @column(name = "enabled") private boolean enabled; @column(name = "login") private string login; @column(name = "password") private string password; @jsonmanagedreference("role") @onetomany(mappedby = "user", cascade = cascadetype.all,fetch = fetchtyp...
Read more

C++ 11 "class" keyword -

C++ 11 "class" keyword - i've started using c++ 11 little bit more , have few questions on special uses of class keyword. know it's used declare class, there's 2 instances have seen don't understand: method<class t>(); and class class_name *var; why precede typename keyword class in first example, , keyword pointer in sec example? that known elaborated type specifier , necessary when class name "shadowed" or "hidden" , need explicit. class t { }; // love of god don't t t; t t2; if compiler smart, give these warnings: main.cpp:15:5: error: must utilize 'class' tag refer type 't' in scope t t2; ^ class main.cpp:14:7: note: class 't' hidden non-type declaration of 't' here t t; ^ if class not defined, deed forwards declaration. for example: template <typename t> void method() { using type = typename t::value_type; } method...
Read more