605.789.81 - Service API Design and Development

Course Structure

The course materials are divided into modules which can be accessed by clicking Modules on the course menu. A module will have several sections including the overview, content, readings, discussions, and assignments. You are encouraged to preview all sections of the module before starting. 

• Usually each course module starts on Tuesday of a given week.
• Each course module runs for a period of seven (7) days, i.e., one week, exceptions are noted in the Course Syllabus.
• Usually, each module Due dates for the assignments are referred to by the day of the module week in which they are due.
• Please refer to the Calendar for the specific start and end dates for each module in this course.
• You should regularly check the Calendar and Announcements for assignment due dates.

Course Topics

• Introduction to services, microservices and APIs
• REST architecture style, principles and constraints
• Service Design Patterns
• RESTful Web services development with jersey JAX-RS API and with Spring framework
• SOAP Web services development
• API documentation with Open API specification
• API testing techniques
• Security of RESTful services

Course Goals

The goal of this course is to explore core aspects for designing, developing, configuring, securing, deploying, and testing Java-based services and service APIs using industry adopted design patterns, modern Spring frameworks and libraries. Particular focus is on studying RESTful services and microservices, and interoperation across application components using APIs. The course also introduces the data exchange mechanism and common data formats, as well as security measures and solutions. The course content is supported by extensive hands-on assignments and projects where students will apply newly learned techniques and best practices using the iterative approach of enhancing requested capabilities.

Course Learning Outcomes (CLOs)

• Identify the purpose for services and service APIs in solving an enterprise business and IT challenges.
• Evaluate and apply RESTful services principles and design patterns.
• Develop API specification using OpenAPI 3.0 standard and Swagger toolset.
• Develop secured RESTful services using Spring Framework ecosystem.
• Perform API testing and debugging.
• Deploy services on premise and on cloud-based platforms.

Textbooks

Not required.

Student Coursework Requirements

• Weekly graded assignments (65% of the total grade)
• Weekly discussions (15% of the total grade)
• Final course project (20% of the total grade)
• Self-Check quizzes

Grading Policy

Course Evaluation

Weekly Graded Assignments (65% of the total grade)

Weekly assignments will be completed individually. The assignments will vary depending on module learning objectives.

The weekly assignments will vary in their complexity and effort. Therefore, you should expect that some of the weekly assignments will be weighted more than other assignments.

The total breakdown of the weekly assignments will be provided in the syllabus.

Weekly Discussions (15% of the total grade) 

We will have several asynchronous discussions on topics related to the module learning objectives, see "Discussion Requirements, Guidelines and Rubrics" document.

Final Course Project (20% of the total grade) 

The final project submitted in Module 14 will assess the students’ achievement of the learning objectives over the entire course.

The final project will be broken down into two main components:

1. Final project implementation component (70% of the final project grade)
2. Final project presentation component (30% of the final project grade) 

Self-check activities (quizzes)

There will be brief, ungraded checks for understanding and quizzes in each module.

Although self-check activities are not count for a grade, they are there to help you gauge your progress and understanding of the module topic and the interconnectedness of the topics.

Course Policies

Homework is expected to be turned in through the assignment items within the modules; it will be considered late if it is received after that time. Special circumstances (e.g., temporary lack of internet access) can be cheerfully accommodated if the student informs us in advance.

Homework that is unjustifiably late will have the grade reduced for lateness, one letter grade lower for every week being late.

Students are expected to participate/submit the following to receive a grade for the course:

• Preparation and participation (class discussions)
• Homeworks
• Course quiz
  
• Course final team project 

We generally do not directly grade spelling and grammar. However, egregious violations of the rules of the English language will be noted without comment. Consistently poor performance in either spelling or grammar is taken as an indication of poor written communication ability that may detract from your grade. 

Academic Policies

Deadlines for Adding, Dropping and Withdrawing from Courses

Students may add a course up to one week after the start of the term for that particular course. Students may drop courses according to the drop deadlines outlined in the EP academic calendar (https://ep.jhu.edu/student-services/academic-calendar/). Between the 6th week of the class and prior to the final withdrawal deadline, a student may withdraw from a course with a W on their academic record. A record of the course will remain on the academic record with a W appearing in the grade column to indicate that the student registered and withdrew from the course.

Academic Misconduct Policy

All students are required to read, know, and comply with the Johns Hopkins University Krieger School of Arts and Sciences (KSAS) / Whiting School of Engineering (WSE) Procedures for Handling Allegations of Misconduct by Full-Time and Part-Time Graduate Students.

This policy prohibits academic misconduct, including but not limited to the following: cheating or facilitating cheating; plagiarism; reuse of assignments; unauthorized collaboration; alteration of graded assignments; and unfair competition. Course materials (old assignments, texts, or examinations, etc.) should not be shared unless authorized by the course instructor. Any questions related to this policy should be directed to EP’s academic integrity officer at ep-academic-integrity@jhu.edu.

Students with Disabilities - Accommodations and Accessibility

Johns Hopkins University values diversity and inclusion. We are committed to providing welcoming, equitable, and accessible educational experiences for all students. Students with disabilities (including those with psychological conditions, medical conditions and temporary disabilities) can request accommodations for this course by providing an Accommodation Letter issued by Student Disability Services (SDS). Please request accommodations for this course as early as possible to provide time for effective communication and arrangements.

For further information or to start the process of requesting accommodations, please contact Student Disability Services at Engineering for Professionals, ep-disability-svcs@jhu.edu.

Student Conduct Code

The fundamental purpose of the JHU regulation of student conduct is to promote and to protect the health, safety, welfare, property, and rights of all members of the University community as well as to promote the orderly operation of the University and to safeguard its property and facilities. As members of the University community, students accept certain responsibilities which support the educational mission and create an environment in which all students are afforded the same opportunity to succeed academically. 

For a full description of the code please visit the following website: https://studentaffairs.jhu.edu/policies-guidelines/student-code/

Classroom Climate

JHU is committed to creating a classroom environment that values the diversity of experiences and perspectives that all students bring. Everyone has the right to be treated with dignity and respect. Fostering an inclusive climate is important. Research and experience show that students who interact with peers who are different from themselves learn new things and experience tangible educational outcomes. At no time in this learning process should someone be singled out or treated unequally on the basis of any seen or unseen part of their identity. 
 
If you have concerns in this course about harassment, discrimination, or any unequal treatment, or if you seek accommodations or resources, please reach out to the course instructor directly. Reporting will never impact your course grade. You may also share concerns with your program chair, the Assistant Dean for Diversity and Inclusion, or the Office of Institutional Equity. In handling reports, people will protect your privacy as much as possible, but faculty and staff are required to officially report information for some cases (e.g. sexual harassment).

Course Auditing

When a student enrolls in an EP course with “audit” status, the student must reach an understanding with the instructor as to what is required to earn the “audit.” If the student does not meet those expectations, the instructor must notify the EP Registration Team [EP-Registration@exchange.johnshopkins.edu] in order for the student to be retroactively dropped or withdrawn from the course (depending on when the "audit" was requested and in accordance with EP registration deadlines). All lecture content will remain accessible to auditing students, but access to all other course material is left to the discretion of the instructor.